Submit

POST

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

Request

This endpoint expects an object.
objectstringRequired

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

surveystringRequired

The ID of the survey to submit the response to.

dispatch_idstringOptional

The unique ID associated with the dispatched survey.

dispatched_channelslist of longsOptional

The ordinals of the source channels on which the survey is sent.

recipientstringOptional

The unique ID associated with the recipient of the survey.

responsemap from strings to anyOptional

Survey response submitted for the object.

response_scoreintegerOptional

The response score for the survey. Only applicable for CSAT and NPS.

source_channelstringOptional

The source channel from which survey response is submitted.

stagelongOptional

The stage ordinal of the survey response object.

Response

This endpoint returns a map from strings to any.