API ReferenceSurveys

Submit Surveys

Submits a user response to a survey, which is defined by the survey ID.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
objectstringRequiredformat: "id"

The ID of the object this survey is on (e.g. ticket, conversation, etc).

surveystringRequiredformat: "id"
The ID of the survey to submit the response to.
dispatch_idstringOptionalformat: "id"
The unique ID associated with the dispatched survey.
dispatched_channelslist of longsOptional
The ordinals of the source channels on which the survey is sent.
recipientstringOptionalformat: "id"
The unique ID associated with the recipient of the survey.
responseobjectOptional
Survey response submitted for the object.
response_scoreintegerOptional
The response score for the survey. Only applicable for CSAT and NPS.
source_channelstringOptionalformat: "text"
The source channel from which survey response is submitted.
stagelongOptional
The stage ordinal of the survey response object.

Response

Success.

Errors