---
title: "Capture User Feedback and Ratings"
method: POST
path: "/ratings"
tags: ["Interactions"]
---

# Capture User Feedback and Ratings

`POST /ratings`

Record user feedback and ratings for conversations or individual messages.

Use this endpoint to collect feedback about response quality or overall conversation experiences. You can rate either a specific message (using `messageId` or `externalMessageId`) or an entire conversation (using `conversationId` or `externalConversationId`).

## Request body

- RatingsRequest — Request payload for logging ratings.
  - `productId` string, uuid, required — The Greenflash product ID to rate.
  - `conversationId` string, uuid — The Greenflash conversation ID to rate. Either conversationId, externalConversationId, messageId, or externalMessageId must be provided.
  - `externalConversationId` string — Your external conversation identifier to rate. Either conversationId, externalConversationId, messageId, or externalMessageId must be provided.
  - `messageId` string — The Greenflash message ID to rate. Either conversationId, externalConversationId, messageId, or externalMessageId must be provided.
  - `externalMessageId` string — Your external message identifier to rate. Either conversationId, externalConversationId, messageId, or externalMessageId must be provided.
  - `rating` number, required — The rating value. Must be between ratingMin and ratingMax (inclusive).
  - `ratingMin` number, required — The minimum possible rating value (e.g., 1 for a 1-5 scale).
  - `ratingMax` number, required — The maximum possible rating value (e.g., 5 for a 1-5 scale).
  - `ratedAt` string, date — When the rating was given. Defaults to current time if not provided.
  - `feedback` string — Optional text feedback accompanying the rating.

## Response `200`

Rating logged successfully

- RatingsResponse — Success response for rating logging.
  - `success` boolean, required — Whether the API call was successful.

## Other responses

- `500` — Server error

## Changes

- **2026-03-12** `51d576458472` — 1 breaking
  - the `ratedAt` request property type/format changed from `string`/`date-time` to `string`/`date`
- **2026-02-18** `d5edd18f9685` — 1 info
  - the `ratedAt` request property type/format was generalized from `string`/`date` to `string`/`date-time`
- **2025-11-24** `c1998d918478` — 1 info
  - api tag `Interactions` added
- **2025-10-06** `8ac2a6f673ac` — 1 breaking
  - the `ratedAt` request property type/format changed from `string`/`` to `string`/`date`
- **2025-09-22** `2a1e19512c0c` — 1 breaking
  - added the new required request property `productId`

[Full history](https://skmtc.dev/greenflash-ai/apis/greenflash-api-reference/changes/ratings/post.md)

---

[API](https://skmtc.dev/greenflash-ai/apis/greenflash-api-reference.md) · [All operations](https://skmtc.dev/greenflash-ai/apis/greenflash-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/greenflash-ai/greenflash-api-reference/revisions/c566e560677d/schema)