Records a thumbs up or down on an answer. Use it when your chatbot asks customers whether an answer helped. The vote shows on the answer in Conversations, and a thumbs down puts the question on the Unanswered list. The website widget sends its Was this helpful? votes here.
Accepts a secret key, a website key or a preview key. Feedback isn’t rate-limited and isn’t charged.
Request
Section titled “Request”| Field | Type | Required | Description |
|---|---|---|---|
answer_id | string | Yes | The answer_id from POST /answer, or snoowl.answer_id from POST /chat/completions. |
helpful | boolean | Yes | true for a thumbs up, false for a thumbs down. Must be a JSON boolean, not a string. |
note | string | No | What the customer said, shown with the vote in Conversations. Up to 500 characters are kept. |
Example
Section titled “Example”Response
Section titled “Response”A 200 with an empty object:
Sending feedback again for the same answer replaces the earlier vote and note.
Errors
Section titled “Errors”| Status | Why |
|---|---|
400 | helpful is missing or isn’t true or false |
401 | The key is missing, unknown or revoked |
403 | A website key used from a site that isn’t on its list |
404 | No answer with that ID for this key’s assistant. Answers from another assistant aren’t found, and neither are answers already deleted under the assistant’s Keep conversations for setting. |
See the error format.