public
POST /v1/public/chat/{publicKey}/conversations/{conversationId}/human
The visitor asks for a person.
Authentication
This endpoint is public. It takes no credential and no organisation — it is what our own marketing site and AI answer engines read.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/public/chat/{publicKey}/conversations/{conversationId}/humanSigned in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Anonymous, authorised by X-Zinn-Chat-Token. Moves the conversation into the operator queue. Idempotent — asking twice is the same as asking once.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
publicKey (path) | string | Yes | The widget's public key. Public by design — it ships in the page source of every site that embeds the widget — so it NAMES a widget and authorises nothing; the Origin header is… |
conversationId (path) | string | Yes | — |
after (query) | integer | No | Return the turns after this seq. Omitted, only the turns this call wrote are returned — the widget appends what it is handed, so the thread from 0 would show the visitor the… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
state | string<ai, waiting, open, offline, closed> | Yes | — |
cursor | integer | Yes | — |
poll_after_ms | integer | Yes | How long the widget should wait before asking again. Decided by the SERVER on every response, because a cadence baked into the widget is cached on somebody else's site behind… |
messages | ChatMessage[] | Yes | — |
Errors this endpoint can return
404 · 429