surveys

Submit

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

Request

This endpoint expects an object.
object
stringRequired
The ID of the object this survey is on (e.g. ticket, conversation, etc).
survey
stringRequired
The ID of the survey to submit the response to.
dispatch_id
stringOptional
The unique ID associated with the dispatched survey.
dispatched_channels
list of integersOptional
The ordinals of the source channels on which the survey is sent.
recipient
stringOptional
The unique ID associated with the recipient of the survey.
response
map from strings to anyOptional
Survey response submitted for the object.
response_score
integerOptional
The response score for the survey. Only applicable for CSAT and NPS.
source_channel
stringOptional
The source channel from which survey response is submitted.
stage
integerOptional
The stage ordinal of the survey response object.

Response

This endpoint returns a map from strings to any
Built with