Storefront APIEngagement
Mark the chat as read
The shopper saw the team's messages: they turn read for the team.
Path Parameters
key*string
The chat channel's public key (data-key of the embed script)
conversation_id*string
Conversation id
Format
uuidQuery 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.
Length
length <= 255Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/widget/string/conversations/497f6eca-6276-4993-bfeb-53cbbbba6f08/read"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"
}