Perform create operation on participants in batch.

1min

POST
https://{tenantSubdomain}/core/api/v2/participants/{participantTypePluralName}/batch
API to create participants in batch via JSON payload for a participant type specified by participantTypePluralName.
Path Parameters
participantTypePluralName
ParticipantTypePluralName
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
X-COREOS-ORIGIN-TOKEN
string
*
X-COREOS-CALLBACK-SECRET
string
Body Parameters
body
ParticipantBatchCreateRequest
*
Description
create batch request for participant type.
All Of
ParticipantBatch  +
payload
ParticipantCreateBatchRequest[]
*
All Of
BaseAttributes  +
callback
CallbackForInstance
Responses
202
OK - The request Accepted.
BatchSuccessResponse
data
object
request
Request
400
Bad request - The server is unable to process the request due to something that is perceived to be a client error
ErrorResponse
error
Error
*
request
Request
*
401
Unauthorized -  The client's identity is unknown to the server. Verify that you are accessing the correct tenant and that your client ID and client secret are valid on that tenant.
ErrorResponse
error
Error
*
request
Request
*
404
Not found - The server can not find the requested resource.
ErrorResponse
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
curl --location --globoff 'https://{tenantSubdomain}/core/api/v2/participants/{participantTypePluralName}/batch' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "payload": {}
}'
curl --location --globoff 'https://{tenantSubdomain}/core/api/v2/participants/{participantTypePluralName}/batch' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "payload": {}
}'
Responses
202
400
401
404
// OK - The request Accepted. 
{
  "data": {
    "id": ""
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// OK - The request Accepted. 
{
  "data": {
    "id": ""
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
﻿
﻿

Updated 31 May 2024

Did this page help you?

Transition the current state of the participant.

Perform update operation on participants in batch.