DokumentacjaEngagement Platform API
Sign inGet started
Guides
API

Update participant by ID

PATCH
/workspaces/{workspaceId}/conversations/{conversationId}/participants/{conversationParticipantId}
Update a participant's status in the conversation
Treść żądania
status
string
Participant status in the conversation.
Possible values: pending, invited, active
Treść odpowiedzi
avatarUrl
string
contact
object
Pokaż atrybuty podrzędne
contact.identifierKey
string
wymagane
contact.identifierValue
string
wymagane
contact.platformAddress
string
contact.platformAddressSelector
string
conversationId
string
createdAt
string
displayName
string
id
string
wymagane
resourceUri
string
status
string
Possible values: invited, pending, active, inactive
type
string
wymagane
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
updatedAt
string
Przykład kodu
curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/conversations/{conversationId}/participants/{conversationParticipantId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Examples

Przykład kodu
curl -X PATCH "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/conversations/c9c60caa-eaf5-4628-9687-91de4d452bfa/participants/280b4743-d753-4767-8516-2fd506e29953" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd" \
-d '{
  "status": "active"
}'