Survey Response Output

Output representation of the response to the Submit Survey request. The response includes the status of the survey unAuth response API and the Thank You page details in the survey.
JSON example
{
    "languageCode": "en",
    "invitationId": "0Kixx0000004MWaCAM",
    "invitationUuid": "11845-39854594-3438",
    "flowInterviewState": "state1",
    "status": "Success",
    "surveyPage": {
        "label": "Page 2",
        "name": "p_d84afb73_3a30_4a3f_aae7_b0478b3bb4ed",
        "surveyQuestions": [
            {
                "name": "q_856a997e_be2c_4ea3_b70d_7f6fb9cfbf4f",
                "label": "Good so Far !",
                "questionType": "ShortText",
                "responseDataType": "STRING",
                "isResponseRequired": false
            }
        ]
    },
    "navigationActions": [
        "Next",
        "Back"
    ],
  "responseId": "0Myxx0000004CYqCAM",
    "errors": []
}
Properties
Property Name Type Description Available Version
errors String[] Error messages for a failed request. v1
flowInterview​State String State of the flow interview. v1
invitationId String ID of the survey invitation that's related to the request. v1
invitationUuid String Random ID of the survey invitation that’s generated for enhanced security. v1
languageCode String Code of the language to get the survey page or question details. v1
navigation​Actions String Available navigation actions on the survey page.
Possible values are:
  • Back—Go to the previous survey page.
  • Next—Go to the next survey page.
v1
responseId String ID of the survey response. v1
status String Status of the API request.
Possible values are:
  • Failure—Survey unAuth Response API isn’t successfully run.
  • Success—Survey unAuth Response API is successfully run.
v1
surveyPage Survey Question Page Output

OR

Survey Thank You Page Output

Details of the question or the Thank You page. v1