Skip to main content
PUT
Submit feedback on a conversation
Submit or replace feedback — a thumbs rating and/or a free-text comment — on a conversation’s latest answer. The feedback is stored on the answer exactly like the in-app 👍 / 👎, so feedback left through the API and through the ClarityQ app are interchangeable and appear in the same places. You only pass the conversation_id: the server resolves which answer to rate from the conversation’s latest message. The conversation must be completed — submitting before the answer is ready returns 409. The call is idempotent: submitting again fully replaces the previous feedback for that answer. Provide at least one of rating or comment; send "rating": null to clear a rating.
Example request
Example response

Authorizations

X-API-Key
string
header
required

API key obtained from the ClarityQ dashboard.

Path Parameters

product_id
string<uuid>
required
conversation_id
string<uuid>
required

Body

application/json

Feedback to set on an answer; written to the answer's metadata.rating.

rating
enum<string> | null

Thumbs rating on the answer (POSITIVE or NEGATIVE). null clears the rating.

Available options:
POSITIVE,
NEGATIVE
comment
string | null

Optional free-text comment on the answer.

Maximum string length: 2000

Response

Successful Response

The feedback stored on an answer (its metadata.rating).

conversation_id
string<uuid>
required

Conversation the answer belongs to.

updated_at
string<date-time>
required

When the feedback was last set (RFC3339 UTC).

rating
string | null

POSITIVE or NEGATIVE; null if comment-only.

comment
string | null

The comment, if any.