Survey Response Input

Input representation of the details of a survey response.
JSON example

Here’s an example for a single question.

{
 "invitationId": "0Kixx0000004MWaCAM",
 "invitationUuid": "11845-39854594-3438",
 "surveyDeveloperName": "sample_survey",
 "languageCode": "en",
 "flowInterviewState" : "state1",
 "navigationAction" : "Next",
 "surveyPageResponses" : {
        "name" :  "p_ff794819_c0f0_4e0d_b357_29ca1694cfc4",
        "questionResponses" : [
            {
                "name": "q_113419b1_5d29_4bb9_8b10_e3fe324ae040",
                "questionType" : "MultiChoice",
                "responses" : [{"name" : "c_9775c2e5_9086_44a8_a5c9_89fdc886c99a"}, 
                                {"name" : "c_0f1f63cc_608a_4560_9d29_72b203f195f2"}]
            }
         ]
   }
}
Properties
Name Type Description Required or Optional Available Version
flowInterview​State String State of the flow interview. Required v1
invitationId String ID of the survey invitation. Required v1
invitationUuid String Random ID of the survey invitation that’s generated for enhanced security. Required v1
languageCode String Code of the language to get the survey page or question details.

Ensure the survey is shared to the participant in this specified language.

Note

Optional v1
navigation​Action String Available navigation actions on the survey page.
Possible values are:
  • Back—Navigate to the previous survey page.
  • Next—Navigate to the next survey page.
Required v1
survey​Developer​Name String Name of the survey. Required v1
surveyPage​Responses Survey Page Response Input Responses to the survey questions on a page. Required v1