Add participant to conversation

Ensure the conversation has a specific participant

post

Add a participant to the conversation if it hasn't already been added

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

Body

one of | nullableoptional

Create a participant of the user or flow type.

Create a participant based on an existing contact. It is optional to set the platformAddressSelector for a given contact to select the attribute for communication.

Create a participant with an identifier value. The contact will be found, or otherwise created, based on the identifier value.

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.bird.com/workspaces/{workspaceId}/conversations/{conversationId}/participants' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "807812e4-da34-4759-95b3-244ab8e29788",
    "type": "user",
    "status": "pending"
  }'

200

201

404

409

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

Participant already exists

Examples

Request

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

Response (201 - Created)

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