For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get conversations configuration

Get channel's conversations configuration

get

This endpoint can be used to verify whether conversations are enabled for a channel, causing incoming messages to start new conversations. If it isn't, you'll need enable it in order to use conversations APIs. This can be done through the UI or by performing a PATCH request.

Authorizations
HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token

Path parameters
workspaceIdstring · uuidRequired

The unique identifier of the workspace.

channelIdstring · uuidRequired

The channel ID

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

The channel's conversations configuration

application/json
statusstring · enumRequired

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

Possible values:
get/workspaces/{workspaceId}/channels/{channelId}/conversational

Examples

curl "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/channels/9673b291-2f71-43c1-a07c-6f2ff0926818/conversational" \
-H "Authorization: AccessKey abcd"

Last updated

Was this helpful?