Update participant by ID

PATCH

/workspaces/{workspaceId}/conversations/{conversationId}/participants/{conversationParticipantId}

Update a participant's status in the conversation

Corps de la requête

status

string

Participant status in the conversation.

Possible values: pending, invited, active

Corps de la réponse

avatarUrl

string

contact

object

Afficher les attributs enfants

contact.identifierKey

string

obligatoire

contact.identifierValue

string

obligatoire

contact.platformAddress

string

contact.platformAddressSelector

string

conversationId

string

createdAt

string

displayName

string

obligatoire

resourceUri

string

status

string

Possible values: invited, pending, active, inactive

type

string

obligatoire

Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation

updatedAt

string

Exemple de code

curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/conversations/{conversationId}/participants/{conversationParticipantId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Examples

Exemple de code

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"
}'

Exemple de code

{
  "id": "3954d22c-96f7-4bc3-817b-67b4d903ed90",
  "type": "contact",
  "status": "active",
  "displayName": "",
  "avatarUrl": "",
  "contact": {
    "identifierKey": "emailaddress",
    "identifierValue": "john.doe@bird.com",
    "platformAddress": "john.doe@bird.com"
  }
}