Update participant by identifier key and value

Update conversation participant by contact

Update a participant's status in the conversation by contact

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

Path parameters

workspaceId*string (uuid)

The workspace ID

conversationId*any of

The conversation ID

enumstring (uuid)

conversationParticipantIdentifierKey*string

The key that refers to the conversation participant identifier

conversationParticipantIdentifierValue*string

The value that refers to the conversation participant identifier

Body

application/json

statusnullable enum

pendinginvitedactive

Response

200404422

Participant was updated

Body

application/json

id*string

displayNamestring

avatarUrlstring

contactConversationParticipantContact

anyany

type*Conversations_ParticipantType (enum)

usercontactflowbotaccessKeychannelconnectorcollaborationAutomation

statusenum

pendinginvitedactive

Request

JavaScriptCurlPython

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

Response

200404422

{
  "id": "text",
  "displayName": "text",
  "avatarUrl": "text",
  "contact": {
    "identifierKey": "text",
    "identifierValue": "text",
    "platformAddress": "text",
    "platformAddressSelector": "text"
  },
  "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/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]"
  }
}