Developer Docs Logo
API RequestsAPI SchemaChatbot conversations

Set the bot paused state on a conversation

POST/v1/conversations/{conversation_id}/bot-state

Enables or disables the paused state of the bot for the given conversation. When the requested state already matches the current state, the request is a no-op and returns 204. Returns 404 when no bot is associated with the conversation. Requires chat:write scope.

Authorization

BearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

conversation_id*string

The unique identifier (UUID) of the conversation.

Formatuuid

Request Body

application/json

Desired bot paused state.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/conversations/d1c6a7f3-0e2b-494c-87f9-94a7a6f9e9cf/bot-state" \  -H "Content-Type: application/json" \  -d '{    "is_paused": true  }'
Empty

Get Channels List GET

Retrieves a paginated list of channels. Requires `channel:read` scope. Sorted by creation date descending.

Create Attachment Upload URL POST

Requests a presigned URL for uploading an attachment file. The client uploads the file directly to the returned `upload_url` via HTTP PUT, then references the returned `attachment_id` when sending an attachment message. The upload URL is single-use, expires after ~5 minutes, and pins both `Content-Type` and `Content-Length` to the values declared in this request. Requires `chat:write` scope.