Create a new participant

1min

POST
https://{tenantSubdomain}/core/api/v2/participants/{participantTypePluralName}
Asynchronous API for creating a new participant of 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
ParticipantCreateRequest
*
Description
Create new participant
All Of
BaseAttributes  +
uniqueCode
string
*
name
string
owner
string
*
properties
object
*
Responses
202
OK - The request Accepted.
SuccessResponseId
data
IdResponse
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
*
Curl
JS
Ruby
Python
curl --location --globoff 'https://{tenantSubdomain}/core/api/v2/participants/{participantTypePluralName}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "uniqueCode": "",
  "owner": "",
  "properties": {}
}'
curl --location --globoff 'https://{tenantSubdomain}/core/api/v2/participants/{participantTypePluralName}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "uniqueCode": "",
  "owner": "",
  "properties": {}
}'
Responses
202
400
401
// 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?

API to get list of orphan reasons codes (not associated with any reason code).

Get list of participants of a participant type.