Conversations

Handoff to human agent

Transfer conversation control from AI to human agent.

Actions performed:

  • Set handoffState to "human"
  • Set autoReplyActive to false (disable AI auto-reply)
  • Record timestamp and user who performed handoff
  • Store optional reason in metadata

Use cases:

  • Customer requests human assistance
  • AI cannot handle complex query
  • Manual intervention required

Note: To return conversation to AI, use PATCH /auto-reply with autoReplyActive: true

post/api/v1/conversations/{conversationId}/handoff/to-human

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/api/v1/conversations/{conversationId}/handoff/to-human
  • Auth: bearerAuth (a scheme the document does not define)

Path parameters

conversationIdstring required

Conversation ID

Request body

reasonstring

Optional reason for handoff

assignedUserIdstring uuid

Optional org member UUID to assign the conversation to

Example request

{
  "reason": "Customer requested to speak with a human agent",
  "assignedUserId": "550e8400-e29b-41d4-a716-446655440000"
}

Response

Created

successtrue required
messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.