Skip to main content
PUT
Sets your rating of one answer, or replaces the rating you already gave it. You can rate only in a conversation you started, and only an answer: rating a question returns 400. Each caller has at most one rating per answer, so sending this again changes the rating and keeps its id and created_at. A rating of down puts the question that was answered into List unanswered questions with the reason rated_unhelpful, where an Owner or Administrator reads it with the note. See Analytics. A conversation that does not exist, belongs to another organization or was started by someone else returns 404, and so does a message that is not in it or a malformed ID. That includes an owner or admin, who can read the ratings on a colleague’s conversation but cannot add one. A credential that cannot send messages gets 403.
string
required
The conversation ID.
string
required
The answer’s id, from Send a message or List messages.
string
required
up or down. Any other value returns 400.
string
An optional note, stored as plain text, of up to 1,000 characters. Leading and trailing space is removed, and a blank note is stored as none. Control characters are refused.

Response

The stored rating.
string
required
The rating’s ID.
string
required
The answer that was rated.
string
required
The conversation the answer belongs to.
string
required
up or down.
string | null
required
The note sent with the rating, or null.
object
required
Who gave the rating: type is user for a console session or service for an API key, and id identifies that user or key.
string
required
When the rating was first given, ISO 8601 in UTC.
string
required
When the rating was last set, ISO 8601 in UTC.
Last modified on October 13, 2026