Update core and custom attributes of a participant.

1min

PUT
https://{tenantSubdomain}/core/api/v2/participants/{participantTypePluralName}/{participantId}
API to update custom and core attributes of a participant specified by participantId.
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-ORIGIN-TOKEN
string
*
X-COREOS-CALLBACK-SECRET
string
Body Parameters
body
ParticipantUpdateRequest
*
Description
Update participant
All Of
CoreAttributes  +
properties
object
*
name
string
owner
string
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}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "properties": {}
}'
curl --location --globoff --request PUT 'https://{tenantSubdomain}/core/api/v2/participants/{participantTypePluralName}/{participantId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "properties": {}
}'
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 custom & core attribute values of a participant.

Get aggregate count of participants of a participant type.