Update participant by ID

Update conversation participant

Update a participant's status in the conversation

PATCHhttps://api.bird.com/workspaces/{workspaceId}/conversations/{conversationId}/participants/{conversationParticipantId}

Path parameters

workspaceId*string (uuid)

The workspace ID

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

conversationId*string (uuid)

The conversation ID

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

conversationParticipantId*string

The ID that refers to the conversation participant (e.g. the contact ID if the participant is a contact)

Example: "274bd6ff-3295-49a0-a02d-651fb661d7fb"

Body

application/json

statusnullable enum

Participant status in the conversation.

pendinginvitedactive

Response

200404422

Participant was updated

Body

application/json

id*string

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"

displayNamestring

The participant's name.

Example: "John Doe"

avatarUrlstring

An URL to the participant's avatar.

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

contactConversations_ParticipantContact (object)

The participant's contact information. For more information on identifier keys and values, please refer to the "Conversation Participants" page.

type*Conversations_ParticipantType (enum)

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.

usercontactagentflowbotaccessKeychannelconnectorcollaborationAutomation

statusenum

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.

pendinginvitedactive

Request

JavaScriptCurlPython

const response = await fetch('https://api.bird.com/workspaces/{workspaceId}/conversations/{conversationId}/participants/{conversationParticipantId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200404422

{
  "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": "pending"
}

Examples

Request

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

Response (200 - OK)

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