Skip to content

Import participants​

POST
/communities/{id}/participants:import

Imports a minimal list of e-mail, GSY DEX actor identifier, meter identifier and role. The import creates the participant, the identity-provider account and the invitation (REQ-008).

Authorizations​

bearerAuth
Type

Parameters​

Path Parameters

id*

Resource identifier.

Required

Request Body​

application/json
JSON
{
  
"participants": [
  
  
{
  
  
  
"email": "string",
  
  
  
"marketActorId": "string",
  
  
  
"meterId": "string",
  
  
  
"role": "string",
  
  
  
"existingIdpSubject": "string"
  
  
}
  
]
}

Responses​

Imported participants.

application/json
JSON
[
  
{
  
  
"participantId": "string",
  
  
"communityId": "string",
  
  
"role": "string",
  
  
"status": "string",
  
  
"marketActorId": "string",
  
  
"meterId": "string",
  
  
"name": "string",
  
  
"email": "string"
  
}
]

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

Horizon Europe INTELLIGENT (GA 101160678) · Task T5.6 · Deliverable D5.5