DocumentazioneEngagement Platform API
Sign inGet started
Guides
API

Update participant by v key and value

PATCH
/workspaces/{workspaceId}/conversations/{conversationId}/participants/{identifierKey}/{identifierValue}
Update a participant's status in the conversation by specifying their identifier key and value. For more information on identifier keys and values, please refer to the "Conversation Participants" page.
Payload della richiesta
status
string
Participant status in the conversation.
Possible values: pending, invited, active
Payload della risposta
avatarUrl
string
contact
object
Mostra attributi secondari
contact.identifierKey
string
obbligatorio
contact.identifierValue
string
obbligatorio
contact.platformAddress
string
contact.platformAddressSelector
string
conversationId
string
createdAt
string
displayName
string
id
string
obbligatorio
resourceUri
string
status
string
Possible values: invited, pending, active, inactive
type
string
obbligatorio
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
updatedAt
string
Esempio di codice
curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/conversations/{conversationId}/participants/{identifierKey}/{identifierValue}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Examples

Esempio di codice
curl -X PATCH "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/conversations/c9c60caa-eaf5-4628-9687-91de4d452bfa/participants/emailaddress/john.doe@bird.com" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd" \
-d '{
  "status": "active"
}'