Developer Docs Logo
API RequestsAPI SchemaChats

Request Conversation Transfer

POST/v1/conversations/{conversation_id}/transfer

Creates a transfer request to move a conversation to another agent.

Requires chat:write scope.

Authorization

BearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

conversation_id*string

The unique identifier (UUID) of the conversation to transfer.

Formatuuid

Request Body

application/json

Transfer details including the target agent and optional message.

TypeScript Definitions

Use the request body type in TypeScript.

Request body for creating a conversation transfer request.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/conversations/8b86b34d-3d4e-4f20-9d55-9d4c93d0b8a2/transfer" \  -H "Content-Type: application/json" \  -d '{    "recipient_id": "9e9097a8-5c9a-4e1e-8218-3b833d8b0039",    "requester_id": "9e9097a8-5c9a-4e1e-8218-3b833d8b0039",    "message": "Please take over this conversation."  }'
Empty