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.

Possible values:

Responses

200

The channel's conversations configuration

application/json

404

The resource specified in the URL was not found

application/json

422

The request body did not pass validation

application/json

patch

HTTPcURLJavaScriptPython

PATCH /workspaces/{workspaceId}/channels/{channelId}/conversational HTTP/1.1
Host: api.bird.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "status": "active"
}

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