public

POST /v1/public/chat/{publicKey}/conversations/{conversationId}/ticket

The visitor turns the chat into a support ticket (our own websites only).

All public endpoints

All developer docs →

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}/ticket \
  -H "Content-Type: application/json" \
  -d '{ "email": <string>, "message": <string> }'

Signed 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. Only OUR OWN chat widget (owned by the platform org) has this route; every customer's widget answers 404, like an unknown key. Files a real support ticket in the plugin-support desk with the chat transcript attached, e-mails the visitor a copy, and the AI ticket agent answers it. Four controls in order, so the vendor call is last: a fail-closed budget per client and globally (429), the visitor token, a honeypot field (website, answered 202 and discarded), and Cloudflare Turnstile verified server-side and fail-closed (422).

Parameters

NameTypeRequiredWhat it is
publicKey (path)stringYesThe 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)stringYes—
after (query)integerNoReturn 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…

Request body

NameTypeRequiredWhat it is
emailstringYes—
namestringNo—
subjectstringNo—
messagestringYes—
turnstile_tokenstringNo—
deflection_idUuid | nullNoThe AI answer shown first (answerPublicChatTicket), counted in the support stats.
websitestringNoA honeypot. Leave empty; a filled one is accepted and discarded.

Response

NameTypeRequiredWhat it is
statestring<ai, waiting, open, offline, closed>Yes—
cursorintegerYes—
poll_after_msintegerYesHow 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…
messagesChatMessage[]Yes—
referencestringYesThe ticket's public reference (ZT-XXXXXX), also e-mailed to the visitor.

Errors this endpoint can return

404 · 422 · 429