Skip to main content
POST
Capture a CSAT score (1-5, tool-specific)

Authorizations

Authorization
string
header
required

Company secret API key.

Body

application/json
score
number
required

CSAT satisfaction score 1-5

Required range: 1 <= x <= 5
Example:

4

csatToolId
string<ObjectId>
required

CSAT tool id (always required: CSAT tools are always custom)

clientEmail
string<email>

Respondent email. Omit for an anonymous capture.

anonymous
boolean

Whether the submission is anonymous (no client email stored).

responseChannel
string

Inbound response channel. Defaults to 'api'; a value provided here REPLACES 'api' (user-defined channel). Stored on the response.

Maximum string length: 48
Example:

"my-crm"

dispatchToken
string

Opaque invitation dispatch token echoed from the link (?dtoken=). Consumed to mark the outbound invitation responded; never persisted.

Maximum string length: 64

Response

CSAT response created