Transition the current state of the participant.

1min
PUT
https://{tenantSubdomain}/core/api/v2/participants/{participantTypePluralName}/{participantId}/state/event
API to transition the current state of the participant.
Path Parameters
participantTypePluralName
ParticipantTypePluralName
*
participantId
UniqueId
*
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
ParticipantStateUpdateRequest
*
Description
Event for participant state transition.
All Of
Event  +
eventCode
EventCode
*
reasonCode
ReasonCode
timestamp
EpochTimestamp
*
data
object
*
source
EventSource
*
callback
CallbackForInstance
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
*
404
Not found - The server can not find the requested resource.
ErrorResponse
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
curl --location --globoff --request PUT 'https://{tenantSubdomain}/core/api/v2/participants/{participantTypePluralName}/{participantId}/state/event' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "eventCode": "",
  "timestamp": 0,
  "data": {},
  "source": {
    "appId": ""
  }
}'
curl --location --globoff --request PUT 'https://{tenantSubdomain}/core/api/v2/participants/{participantTypePluralName}/{participantId}/state/event' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "eventCode": "",
  "timestamp": 0,
  "data": {},
  "source": {
    "appId": ""
  }
}'
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?
Get the current state of the participant.
Perform create operation on participants in batch.