Submit a customer satisfaction score
Record a customer's satisfaction score for a solved ticket.
/v1/csat/{ticket_id}No credential- Operation id
- submit_csat
- Access
- Public by design. No credential is required or consulted.
/v1/csat/{ticket_id}Record a customer's satisfaction score for a solved ticket.
This is what the link in a solved-ticket email points at. No credential is required or consulted: the ticket id in the URL is the credential, so treat that link as a secret and do not put it anywhere public.
score is 1 to 5. The score is written onto the ticket and a
csat_response entry is added to its timeline, so an operator sees the
result where they see everything else about the ticket.
Submitting again overwrites the previous score for the same ticket rather than adding a second one, which is what makes a resent link safe.
An unknown ticket is 404. Rate limited per ticket, because the ticket id in the URL is the credential: the thing worth bounding is how fast one can be guessed at, or one customer's score rewritten, and neither is a per workspace question.
Tenancy: public and unauthenticated by design. No credential and no role is required or consulted; the workspace is resolved from the request itself (a body tenant_id, a URL token, or an agent id).
Access: no credential.
Path Parameters
uuidRequest 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/v1/csat/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{ "score": 5, "comment": "Sorted quickly, thank you.", "email": "sam.okafor@northwind.example" }'{ "status": "recorded", "ticket_id": "5e8b0c31-7a4d-4f92-b6c8-1d3e2a5f7b90", "score": 5}