SurveyOption Sub-Object v5

The following API calls are currently available for the SurveyOption object:

For info on returned fields and example returns go to SurveyOption Returned Fields.

GET LIST - Get a list of all of your survey options for a specified survey question. View Example Return.

https://restapi.surveygizmo.com/v5/survey/123456/surveyquestion/1/surveyoption
ParametersExampleRequired
Authentication Credentialsapi_token=5D685159B6964FB69B044D3E7D2676D1True

GET SURVEYOPTION - Get information about a specified survey option. View Example Return.

https://restapi.surveygizmo.com/v5/survey/123456/surveyquestion/1/surveyoption/10001
ParametersExampleRequired
Authentication Credentialsapi_token=5D685159B6964FB69B044D3E7D2676D1True

CREATE SURVEYOPTION - Create a new survey option. View Example Return.

https://restapi.surveygizmo.com/v5/survey/123456/surveypage/1/surveyquestion/1/surveyoption?_method=PUT&title=Option Title&value=Reporting Value
ParametersExampleRequired
Authentication Credentialsapi_token=5D685159B6964FB69B044D3E7D2676D1True
titleoption title textTrue
valuereporting valueTrue
afterid of option to followFalse
PropertiesExampleRequired
properties[dependent]Question IDs for trigger questions (comma separated)False
properties[other]trueFalse
properties[requireother]trueFalse
properties[na]trueFalse
properties[none]trueFalse
properties[all]trueFalse
properties[fixed]trueFalse
properties[heatmap-color]*ff0000 (this is a hex code without the #)False

Back to the Top

UPDATE SURVEYOPTION - Update a specified surveyoption. View Example Return.

https://restapi.surveygizmo.com/v5/survey/123456/surveyquestion/1/surveyoption/10001?_method=POST
ParametersExampleRequired
Authentication Credentialsapi_token=5D685159B6964FB69B044D3E7D2676D1True
titleoption title textFalse
valuereporting valueFalse
afterid of option to followFalse
PropertiesExampleRequired
properties[dependent]Question IDs for trigger questions (comma separated)False
properties[other]trueFalse
properties[requireother]trueFalse
properties[na]trueFalse
properties[none]trueFalse
properties[all]trueFalse
properties[fixed]trueFalse
properties[heatmap-color]*f06486 (this is a hex code without the #)False


DELETE SURVEYOPTION - Delete a specified survey option. View Example Return.

https://restapi.surveygizmo.com/v5/survey/123456/surveyquestion/1/surveyoption/10001?_method=DELETE
ParametersExampleRequired
Authentication Credentialsapi_token=5D685159B6964FB69B044D3E7D2676D1True

Back to the Top