public

POST `/v1/public/support/deflect`

The AI answer in front of a public support form (plugin support, chat, public).

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/support/deflect \
  -H "Content-Type: application/json" \
  -d '{ "question": <string>, "surface": <string<public, plugin, chat>> }'

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 (s1014 L39). The same grounded answer as the dashboard's "Ask for help" (published KB + live catalogue), for a visitor with no account, recorded in the admin support stats in the platform organization. Returns a deflection_id the ticket then carries (POST /v1/plugin-support/tickets, the chat's ticket form), or that POST /v1/public/support/deflect/{deflectionId}/solved marks as solved. ⛔ Never blocks the ticket: a failed answer comes back with answer.failure set (the §2.57 classes) and the form keeps its submit button. Spends the presales budget per client and globally before the body is read (429).

Request body

Name	Type	Required	What it is
`question`	`string`	Yes	—
`surface`	`string<public, plugin, chat>`	Yes	—
`locale`	`string`	No	—
`product`	`string`	No	—
`category`	`string`	No	—

Response

Name	Type	Required	What it is
`deflection_id`	`Uuid`	Yes	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`answer`	`TicketDeflectionAnswer`	Yes	The AI answer in front of the ticket form (s1014 L39). ⛔ Never blocks the ticket: the form always offers "Still need help? Send it to the team" beside it.
`articles`	`object[]`	Yes	Published help articles matching the question, in the visitor's language.

Errors this endpoint can return

422 · 429