Set human handoff | Atlas

Sets (does not toggle) human handoff for a single contact. Pass the desired state in enabled — true pauses agent replies and routes the conversation to a live agent, false returns it to automated handling. The request body is required; sending {} returns 400 "enabled (boolean) is required in request body".

Authentication

api-keystring

Your Atlas API key. Get it from the Atlas Portal under Settings > API Keys.

Path parameters

campaignIdstringRequired

contactIdentifierstringRequired

Contact phone number (E.164) or Apple ID email.

Request

This endpoint expects an object.

enabledbooleanRequired

Target state. true enables human handoff for the contact, false disables it.

Response

Human handoff state set

Errors

400

Bad Request Error

500

Internal Server Error

$	curl -X POST https://api.youratlas.com/v1/api/campaign-chat/campaignId/contacts/contactIdentifier/human-handoff \
>	-H "api-key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"enabled": true
>	}'