Enigma Developers
API ReferenceHandover

Request a human agent

POST
/v1/handover

Moves the contact's latest conversation into the live-chat queue, so the bot stops replying and an agent can pick it up. Returns success: false if a handover is already requested. Requires scope conversation:handover:request.

Authorization

headerAuthorizationBearer <token>

Your organization API key: Authorization: Bearer org_…

Request Body

application/json
  1. body
audienceExternalId*AudienceExternalId

The contact's ID on its channel. For WhatsApp it is <phone number>:<your WhatsApp phone number ID>.

Response Body

Done, or success: false if already requested.

application/json
  1. response
success*boolean
curl -X POST 'https://api.enigma-ai.com/v1/handover' \  -H 'Content-Type: application/json' \  -d '{  "audienceExternalId": "string"}'
{  "success": true}