A valid request URL is required to generate request examples{
"response": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"score": 123,
"comment": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Answer a survey
Records one answer, and it announces survey.response_recorded to your webhooks — which is what lets you route a detractor to support while the person is still on the page.
The survey has to be one this contact currently has outstanding. Never asked, already answered, withdrawn or asked more than 14 days ago all answer 404: a client that could answer any id could push scores into your NPS from people who were never surveyed.
Safe to submit twice. The delivery is claimed by an update carrying responded_at IS NULL, so of two submissions landing together exactly one records an answer and the other gets 404.
An nps survey requires score — the scale is the question, and an answer with nothing to divide would sit in the numerator of a rate it is not part of. A custom survey takes a score, a comment, or both.
A valid request URL is required to generate request examples{
"response": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"score": 123,
"comment": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Authorizations
A contact session token, uk_ct_…. Belongs to one of the developer's own users, and reads only that user's data.
Path Parameters
Body
Response
Recorded.
Show child attributes
Show child attributes