Update conversations configuration

Set channel's conversations configuration

patch

This endpoint can be used to enable conversations for a channel. You should enable this option if you'd like incoming messages on this channel to start conversations.

Authorizations

MessageBird_userMessageBird_accessKey

Path parameters

workspaceIdstring · uuidrequired

The workspace ID

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

channelIdstring · uuidrequired

The channel ID

Example: ab651378-579a-4491-abe6-eec97d4c0fa3

Body

statusstring · enumrequired

Conversation status. If enabled, creates conversations for incoming messages.

Options: active, inactive

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/conversational' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "active"
  }'

200

404

422

200

{
  "status": "active"
}

The channel's conversations configuration

Examples

Request

curl -X PATCH "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/channels/9673b291-2f71-43c1-a07c-6f2ff0926818/conversational" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd" \
-d '{
  "status": "active"
}'

Response (200 - OK)

{
  "status": "active"
}