Update participant by v key and value

Update conversation participant by contact

patch

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.

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

workspaceIdstring · uuidRequired

The workspace ID

Example: b4e02c85-c6d2-4b15-8885-e09671799c61

conversationIdstring · uuidRequired

The conversation ID

Example: 67e4d358-ca94-421e-98b7-448860df9d33

identifierKeystring · min: 1Required

The identifier type of the channel, such as emailaddress or phonenumber

Example: emailaddress

identifierValuestring · min: 1Required

A value that uniquely identifies a recipient in the channel, such as an email address or a phone number

Example: [email protected]

Body

application/json

statusstring · enum · nullableOptional

Participant status in the conversation.

Possible values:

Responses

200

Participant was updated

application/json

A participant who can send and receive messages in the conversation

idstringRequired

Participant ID, the meaning of this field depends on type. If type is user then it's a user ID, if type is contact then it's a contact ID, if type is accessKey then it's the access key ID, and so on.

Example: cb22b001-6226-4d7c-acdd-7414b2bcdbaf

displayNamestringOptional

The participant's name.

Example: John Doe

avatarUrlstringOptional

An URL to the participant's avatar.

Example: https://example.bird.com/avatar-url

typestring · enumRequired

Participant type. The main ones are user, contact, and agent. user is a user belonging to your Bird workspace, contact is one of your customers, agent is a customer service agent, and the remaining types represent system participants.

Possible values:

statusstring · enumOptional

Participant status in the conversation. pending means it's pending approval, invited means it's pending acceptance from the participant, and active means the participant can send and receive messages.

Default: activePossible values:

404

The resource specified in the URL was not found

application/json

409

The resource is in a conflicting state

application/json

422

The request body did not pass validation

application/json

patch

/workspaces/{workspaceId}/conversations/{conversationId}/participants/{identifierKey}/{identifierValue}

HTTPcURLJavaScriptPython

PATCH /workspaces/{workspaceId}/conversations/{conversationId}/participants/{identifierKey}/{identifierValue} HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "status": "pending"
}

{
  "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
  "displayName": "John Doe",
  "avatarUrl": "https://example.bird.com/avatar-url",
  "contact": {
    "identifierKey": "emailaddress",
    "identifierValue": "[email protected]",
    "platformAddress": "[email protected]",
    "platformAddressSelector": "attributes.workEmail"
  },
  "type": "user",
  "status": "active"
}

Examples

Request

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

Response (200 - OK)