MobiariDocs
Storefront APIEngagement

Rate the chat

POST
/widget/{key}/conversations/{conversation_id}/csat

The shopper's satisfaction score, 1 to 5, with an optional comment.

Path Parameters

key*string

The chat channel's public key (data-key of the embed script)

conversation_id*string

Conversation id

Formatuuid

Query Parameters

token?string

The token POST /widget/{key}/conversations returned. Prefer the X-Visitor-Token header; the query parameter is for clients that cannot set headers.

Header Parameters

Idempotency-Key?string

A unique value (e.g. a UUID) per logical request. Retrying with the same key within 24 hours replays the first response instead of repeating the side effect; the replay carries Idempotent-Replayed: true. Reusing a key for a different request is a 422 idempotency_key_reused; retrying while the first is still running is a 409 idempotency_request_in_progress. JSON bodies up to 1 MB.

Lengthlength <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/widget/string/conversations/497f6eca-6276-4993-bfeb-53cbbbba6f08/csat" \  -H "Content-Type: application/json" \  -d '{    "score": 0  }'
Empty
{
  "code": "not_found",
  "details": {},
  "error": "Order not found"
}
{
  "code": "not_found",
  "details": {},
  "error": "Order not found"
}
{
  "code": "not_found",
  "details": {},
  "error": "Order not found"
}
{
  "code": "not_found",
  "details": {},
  "error": "Order not found"
}
{
  "code": "not_found",
  "details": {},
  "error": "Order not found"
}
{
  "code": "not_found",
  "details": {},
  "error": "Order not found"
}