Chat bot
Rate
Records the visitor's answer to "Did this answer your question?" on the chat ticket. answered=true also closes the ticket with the workspace's first hidden-by-default (closed) status and writes that status change to the ticket log. answered=false returns an AI written fallback_subject and fallback_message to pre-fill the handover form, unless skip_fallback is set or the visitor only ever sent one message.
POST
/api/{tenant:minlength(2)}/v{version:apiVersion}/chat_bot/rate
Request arguments
| Name | Type | Source |
|---|---|---|
| input | DTO_chat_bot_rate_input | Body |
Request body example
Response
Response body example
DTO_chat_bot_rate_input
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| ticket_id | Int32 | Ticket id | |
| session_token | String | Session token | |
| answered | Boolean | Answered | |
| skip_fallback | Boolean | Set by the widget when the No rating is recorded automatically on form fallback (the fallback pre-fill was already delivered on the message response) - skips generating another one. |
DTO_chat_bot_rate_response
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| success | Boolean | True when the rating was recorded. | |
| fallback_subject | String | ReadOnly | On a No rating with a multi-message conversation: AI-written ticket pre-fill for the classic form (visitor's language, first person). Null otherwise - the widget falls back to the visitor's last raw message. |
| fallback_message | String | ReadOnly | Fallback message |
Generated Aug 4, 2026 18:37