Docs

Start here

Answer the survey in a closing email

POST/v1/support/csaton https://api.auray.ai/v1

The last click in a support conversation.

The last click in a support conversation. The token arrives only in the mail that closes a ticket, and only when the ticket was solved, was not spam or quarantined, and the requester wrote at least once. It is answered once; a second answer and an unknown token are answered identically, so nothing here can be used to test whether a token exists. No proof of work: unlike every other unauthenticated write under /v1/support this one cannot be aimed at a stranger, and taxing somebody for answering a question we asked them is the wrong trade.

#Authentication

No key needed — this document is public.

#Request

#Body

application/json, required.

FieldTypeRequiredDefaultDescription
tokenstringyes—The 43-character token from the survey link. 0 to 64 characters.
scoreintegeryes—One to five. Anything else is refused. 1 to 5.
commentstringno—Optional. Kept with the score on the ticket, where support reads it. Sent again with the same score after the survey was answered, it is kept once — the page's second box — and a later one is not. 0 to 2000 characters.

#Example request

curl -X POST https://api.auray.ai/v1/support/csat \
  -H "content-type: application/json" \
  -d '{
  "token": "…",
  "score": 1
}'

#Responses

#200 OK

Thank you. recorded is false when the token was unknown, or already answered (and, for a comment, already commented); the cases are deliberately indistinguishable.

FieldTypeRequiredDefaultDescription
recordedbooleanno—

#400 Bad Request

support_score_invalid — the score is not a whole number from one to five. Nothing was recorded.

#404 Not Found

support_link_invalid — the token is not the shape of a survey link we issue. A well-formed token that is unknown or already answered is not refused: it is the 200 with recorded: false.

#429 Too Many Requests

Too many attempts.

#503 Service Unavailable

support_unavailable — the answer could not be recorded. Nothing was changed; send it again.

#Status codes

StatusMeaning
200Thank you. recorded is false when the token was unknown, or already answered (and, for a comment, already commented); the cases are deliberately indistinguishable.
400support_score_invalid — the score is not a whole number from one to five.
404support_link_invalid — the token is not the shape of a survey link we issue.
429Too many attempts.
503support_unavailable — the answer could not be recorded.

Every refusal names its code, and every code is explained at Errors.

Start typing to search every page of the documentation.

Up arrow Down arrow to moveEnter to openEscape to close