Create a new participant type

1min
POST
https://{tenantSubdomain}/core/api/v2/participants/participant-types
Asynchronous API for creating a new Participant Type by specifying the following parameters in request body: 

 Important: Participant types once created cannot be deleted. Once the participant type is created, it's Singular & Plural names cannot be changed.
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
X-COREOS-CALLBACK-SECRET
string
Body Parameters
body
ParticipantTypeCreateRequest
*
Description
Create new participant type
All Of
BaseParticipantType  +
name
ParticipantTypeName
*
alias
ParticipantAliasName
category
Category[]
allowedOwner
ParticipantTypeAllowedOwner
entityCode
EntityCode
callback
Callback
enableOrchestrator
boolean
Responses
202
OK - The request Accepted.
SuccessResponse
data
NameResponse
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/participant-types' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "name": {
    "singular": "",
    "plural": ""
  },
  "alias": {
    "singular": "",
    "plural": ""
  },
  "category": [
    {
      "name": "",
      "description": "",
      "subCategory": [
        ""
      ]
    }
  ],
  "callback": {
    "url": ""
  }
}'
curl --location --globoff 'https://{tenantSubdomain}/core/api/v2/participants/participant-types' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "name": {
    "singular": "",
    "plural": ""
  },
  "alias": {
    "singular": "",
    "plural": ""
  },
  "category": [
    {
      "name": "",
      "description": "",
      "subCategory": [
        ""
      ]
    }
  ],
  "callback": {
    "url": ""
  }
}'
Responses
202
400
401
// OK - The request Accepted. 
{
  "data": {
    "name": "vehicles"
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// OK - The request Accepted. 
{
  "data": {
    "name": "vehicles"
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
﻿
﻿
Updated 31 May 2024
Did this page help you?
Update Attribute Config of Tenant.
Get all participant types and their configurations