SurveyQuestion Sub-Object

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

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

GET LIST - Get a list of all of your survey questions. View Example Return.

https://restapi.surveygizmo.com/v4/survey/123456/surveyquestion
ParametersExampleRequired
Authentication Credentialsapi_token=abcd12345&api_token_secret=abcd12345
True

GET SURVEYQUESTION - Get information about a specified survey question. View Example Return.

https://restapi.surveygizmo.com/v4/survey/123456/surveyquestion/1
ParametersExampleRequired
Authentication Credentialsapi_token=abcd12345&api_token_secret=abcd12345
True

CREATE SURVEYQUESTION - Create a new survey question. View Example Return.

https://restapi.surveygizmo.com/v4/survey/123456/surveypage/1/surveyquestion?_method=PUT
ParametersExampleRequired
Authentication Credentialsapi_token=abcd12345&api_token_secret=abcd12345
True
surveypageID of page to add question toTrue
typeradio, checkbox, menu, text, essay, email, multitext, single-image, multi-image, contsum, rank-dragdrop, table-radio, table-checkbox, table-textbox, table-menu-matrix, table-stars, file, instructions, media, hidden, urlredirectFalse
titleQuestion textFalse
descriptionDescription textFalse
afterQuestion ID to followFalse
varnameSPSS Variable Name*False
shortnameShortname/AliasFalse
Look & Feel PropertiesExampleRequired
properties[disabled]trueFalse
properties[exclude_number]trueFalse
properties[hide_after_response]trueFalse
properties[option_sort]trueFalse
properties[orientation]HORZ,VERTFalse
properties[labels_right]trueFalse
properties[question_description_above]trueFalse
properties[custom_css]CSS template hookFalse
Validation PropertiesExampleRequired
properties[required]trueFalse
properties[soft-required]trueFalse
properties[force_numeric]trueFalse
properties[force_percent]trueFalse
properties[force_currency]trueFalse
properties[subtype]email, dateFalse
properties[min_number]valueFalse
properties[max_number]valueFalse
properties[min_answers_per_row]valueFalse
properties[minimum_response]valueFalse
properties[inputmask][mask]RegEx PatternFalse
properties[inputmask][message]RegEx PatternFalse
properties[defaulttext]Default text or reporting valueFalse
Logic PropertiesExampleRequired
properties[hidden]trueFalse
properties[piped_from]Question ID to pipe fromFalse
Continuous Sum PropertiesExampleRequired
properties[max_total]valueFalse
properties[max_total_noshow]trueFalse
properties[must_be_max]trueFalse
File Upload PropertiesExampleRequired
properties[maxfiles]1-10False
properties[extentions]png,gif,jpg,doc,xls,docx,xlsx,pdf,txtFalse
URL Redirect PropertiesExampleRequired
properties[url]Redirect URLFalse
properties[outbound][n][fieldname]Variable NameFalse
properties[outbound][n][mapping]Question ID for variable you wish to mapFalse
properties[outbound][n][default]Default Value to be passed when blankFalse

*For question types with multiple fields this must be specified as an array with the option ID as the key. For example, the follow call is used to specify the SPSS variable names for each row of a Textbox List question.
 https://restapi.surveygizmo.com/v4/survey/2120303/surveypage/12/surveyquestion/23.debug?_method=POST&varname[10001]=Comedy&varname[10002]=Drama&varname[10003]=Foreign&varname[10004]=Western

Back to the Top

UPDATE SURVEYQUESTION - Update a specified surveyquestion. View Example Return.

https://restapi.surveygizmo.com/v4/survey/123456/surveyquestion/1?_method=POST
ParametersExampleRequired
Authentication Credentialsapi_token=abcd12345&api_token_secret=abcd12345
True
titleQuestion textFalse
descriptionDescription textFalse
varnameSPSS Variable Name*False
shortnameShortname/AliasFalse
Look & Feel PropertiesExampleRequired
properties[disabled]trueFalse
properties[exclude_number]trueFalse
properties[hide_after_response]trueFalse
properties[option_sort]trueFalse
properties[orientation]HORZ,VERTFalse
properties[labels_right]trueFalse
properties[question_description_above]trueFalse
properties[custom_css]CSS template hookFalse
Validation PropertiesExampleRequired
properties[required]trueFalse
properties[soft-required]trueFalse
properties[force_numeric]trueFalse
properties[force_percent]trueFalse
properties[force_currency]trueFalse
properties[min_number]valueFalse
properties[max_number]valueFalse
properties[min_answers_per_row]valueFalse
properties[minimum_response]valueFalse
properties[inputmask]RegEx PatternFalse
properties[defaulttext]Default text or reporting valueFalse
Logic PropertiesExampleRequired
properties[hidden]trueFalse
properties[piped_from]Question ID to pipe fromFalse
Continuous Sum PropertiesExampleRequired
properties[max_total]valueFalse
properties[max_total_noshow]trueFalse
properties[must_be_max]trueFalse
File Upload PropertiesExampleRequired
properties[maxfiles]1-10False
properties[extentions]png,gif,jpg,doc,xls,docx,xlsx,pdf,txtFalse
URL Redirect PropertiesExampleRequired
properties[url]Redirect URLFalse
properties[outbound][n][fieldname]Variable NameFalse
properties[outbound][n][mapping]

Question ID for variable you wish to map or url if mapping from a URL variable

False
properties[outbound][n][url]The name of the URL variable mapped from, if mapping from a URL variable
properties[outbound][n][default]Default Value to be passed when blankFalse

*For question types with multiple fields this must be specified as an array with the option ID as the key. For example, the follow call is used to specify the SPSS variable names for each row of a Textbox List question.
 https://restapi.surveygizmo.com/v4/survey/2120303/surveypage/12/surveyquestion/23.debug?_method=POST&varname[10001]=Comedy&varname[10002]=Drama&varname[10003]=Foreign&varname[10004]=Western

DELETE SURVEYQUESTION - Delete a specified survey question. View Example Return.

Deleting grid rows is not supported.

https://restapi.surveygizmo.com/v4/survey/123456/surveyquestion/1?_method=DELETE
ParametersExampleRequired
Authentication Credentialsapi_token=abcd12345&api_token_secret=abcd12345
True

Back to the Top