ai_agents

Hand a chat to a human

The chat visitor leaves their details and becomes a lead, with the transcript attached.

This is the ONE place in the agent channel where anything personal is stored, and only because the visitor asked: consent must be literally true (a ticked checkbox), and at least one of phone / email must be present. Otherwise 400 and nothing is written.

The result is a LEAD in the Leads pipeline (source agent_chat) with the transcript on its answer card, linked to a deduped contact. The visitor's ticked box is consent to being contacted about this enquiry, kept on the lead; it never subscribes them to marketing. The team follows up on real channels, so there is no new inbox to watch.

No model runs and nothing is metered here: it would be absurd to charge for receiving a lead.

A PAUSED agent still hands off (a visitor mid-conversation deserves a human, not a wall); only a draft agent answers 404.

The ready-made widget does all of this itself: the visitor types "agent" or clicks the handoff link, fills the inline form, done.

post/api/v1/ai-agents/{id}/chat/handoff

Request

  • Base URL: https://app.blueticked.com
  • URL: https://app.blueticked.com/api/v1/ai-agents/{id}/chat/handoff
  • Auth: HTTP bearer

Path parameters

idstring required

The resource's unique identifier.

Request body

session_idstring required
namestring
phonestring
emailstring
messagestring
consenttrue required

Response

Success

okboolean required
lead_createdboolean required
replystring required

Example response

{
  "ok": true,
  "lead_created": true,
  "reply": "Thanks — the team has your details and the conversation so far, and will be in touch."
}

Changes

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