Update conversations configuration

Set channel's conversations configuration

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.

PATCHhttps://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/conversational

Path parameters

workspaceId*string (uuid)

The workspace ID

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

channelId*string (uuid)

The channel ID

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

Body

application/json

status*enum

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

activeinactive

Response

200404422

The channel's conversations configuration

Body

application/json

status*enum

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

activeinactive

Request

JavaScriptCurlPython

const response = await fetch('https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/conversational', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "status": "active"
    }),
});
const data = await response.json();

Response

200404422

{
  "status": "active"
}

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