Skip to main content
POST
Escalate a lead to human handoff

Authorizations

Authorization
string
header
required

Tenant-issued API key. Format: vapk_live_<48 hex chars> (60 chars total). Issue + manage at /settings/integrations/api-keys in the Vorel dashboard. Each key has a scope set (read, leads:write, appointments:write, offerings:write); endpoints requiring a write scope reject keys without it with a 403 envelope.

Path Parameters

id
string<uuid>
required

UUID of the lead to escalate.

Body

application/json

Both fields optional. Defaults are written into the audit log so the trail is never empty.

reason
string

Short-form trigger label (e.g. 'no-response-7d').

Maximum string length: 200
summary
string

Free-form context for the human picking up the conversation.

Maximum string length: 1000

Response

Handoff recorded.

handoff_id
string<uuid>
required
lead_id
string<uuid>
required
conversation_id
string<uuid>
required
conversation_status
enum<string>
required
Available options:
awaiting_human
notified_channel
enum<string>
required
Available options:
slack,
email