Create a rating

Opportunities module

POST/ratingsratings.create

A two-sided rating from a completed engagement, released together or after 14 days. Creates a rating. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requires the capability opportunities.rating.write.
OAuth scopes: opportunities.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: RatingCreate

ratings.create: RatingCreate
Field	Type	Required	Description
engagement_id	string (uuid)	Yes	Identifier of the completed engagement.
rater_side	string	Yes	Which side rated.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
score	integer	Yes	Score from 1 to 5.Constraints: range 1 to any
comment	string \| null	No	Public comment.Constraints: length 1 to 20000

{
  "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "rater_side": "org",
  "score": 5,
  "comment": "Prepared, punctual and safe."
}

Response 201: Rating

ratings.create: Rating
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the rating.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
engagement_id	string (uuid)	Yes	Identifier of the completed engagement.
rater_side	string	Yes	Which side rated.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
score	integer	Yes	Score from 1 to 5.Constraints: range 1 to any
comment	string \| null	Yes	Public comment.Constraints: length 1 to 20000
released_at	string (date-time) \| null	Yes	When both ratings were released.

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "rater_side": "org",
  "score": 5,
  "comment": "Prepared, punctual and safe.",
  "released_at": "2026-10-08T14:30:00Z"
}

Code samples

curl -X POST "$XOS_BASE_URL/ratings" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"engagement_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","rater_side":"org","score":5,"comment":"Prepared, punctual and safe."}'

const { data } = await xos.ratings.create({
    "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "rater_side": "org",
    "score": 5,
    "comment": "Prepared, punctual and safe."
  });

response = xos.ratings.create({"engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "rater_side": "org", "score": 5, "comment": "Prepared, punctual and safe."})

xos ratings create --data '{"engagement_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","rater_side":"org","score":5,"comment":"Prepared, punctual and safe."}'