Update participant by identifier key and value

Update conversation participant by contact

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.

patch

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

Authorizations

MessageBird_userMessageBird_accessKey

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: [e-mail]

Body

statusstring · enum | nullable

Participant status in the conversation.

Options: pending, invited, active

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.bird.com/workspaces/{workspaceId}/conversations/{conversationId}/participants/{identifierKey}/{identifierValue}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"status":"pending"}'

200

404

422

200

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

Participant was updated

Examples

Request

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

Response (200 - OK)

{
  "id": "3954d22c-96f7-4bc3-817b-67b4d903ed90",
  "type": "contact",
  "status": "active",
  "displayName": "",
  "avatarUrl": "",
  "contact": {
    "identifierKey": "emailaddress",
    "identifierValue": "[e-mail]",
    "platformAddress": "[e-mail]"
  }
}