Skip to content
Linq

Request or return a handoff

POST/v1/chats/{chat}/handoff

Requests a human takeover, or returns control to your system.

Behavior

  • to: "human" moves the chat to human_pending; closed to your sends until a human accepts or control returns.
  • to: "partner" returns control to your system.
  • The event log records who asked: a request carries actor partner, a return carries actor human, and an operator name appears only beside a human actor.
Path ParametersExpand Collapse
chat: string
Body ParametersJSONExpand Collapse
to: "human" or "partner"

human requests a human (owner → human_pending); partner returns control. Anything else returns HTTP 422 code 1071.

One of the following:
"human"
"partner"
reason: optional string

Free-text reason, recorded on the ownership event (absent → empty).

ReturnsExpand Collapse
ok: true

Request or return a handoff

curl https://messages.api.linqapp.com/v1/chats/$CHAT/handoff \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $LINQ_AMB_API_KEY" \
    -d '{
          "to": "human"
        }'
{
  "ok": true
}
Returns Examples
{
  "ok": true
}