register custom code configurations of a participant type

1min
POST
https://{tenantSubdomain}/core/api/v2/participants/participant-types/{participantTypePluralName}/config/handlers
api for registering custom code config
Path Parameters
participantTypePluralName
ParticipantTypePluralName
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
Body Parameters
body
CustomCodeCreateRequest
*
Description
Create new custom code for participantType
url
string
*
requestHeader
object
*
method
Method
*
wait
boolean
*
acceptableStatusCodes
number[]
raiseErrorOnStatusMismatch
boolean
methodName
string<create:onError | update:onError | apply_event:onError | create:onRequest | update:onRequest | apply_event:onRequest>
*
Responses
201
OK - The request Succeeded.
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
*
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/participant-types/{participantTypePluralName}/config/handlers' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "url": "",
  "requestHeader": {},
  "method": "",
  "wait": false,
  "methodName": ""
}'
curl --location --globoff 'https://{tenantSubdomain}/core/api/v2/participants/participant-types/{participantTypePluralName}/config/handlers' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "url": "",
  "requestHeader": {},
  "method": "",
  "wait": false,
  "methodName": ""
}'
Responses
201
400
401
404
// OK - The request Succeeded. 
{
  "data": {
    "id": ""
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// OK - The request Succeeded. 
{
  "data": {
    "id": ""
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
﻿
﻿
Updated 31 May 2024
Did this page help you?
Update participant type configuration
update custom code configurations of a participant type