SurveyQuestion Sub-Object v5

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

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

https://restapi.surveygizmo.com/v5/survey/123456/surveyquestion

Note: Get requests will cache for 60 seconds. If you make repeated API get requests that are identical, the return will be cached and will thus return identical results.
ParametersExampleRequired
Authentication Credentialsapi_token=5D685159B6964FB69B044D3E7D2676D1True

GET SURVEYQUESTION - Get information about a specified survey question.

https://restapi.surveygizmo.com/v5/survey/123456/surveyquestion/1

Note: Get requests will cache for 60 seconds. If you make repeated API get requests that are identical, the return will be cached and will thus return identical results.
ParametersExampleRequired
Authentication Credentialsapi_token=5D685159B6964FB69B044D3E7D2676D1True

CREATE SURVEYQUESTION - Create a new survey question.

https://restapi.surveygizmo.com/v5/survey/123456/surveypage/1/surveyquestion?_method=PUT

ParametersExampleRequired
Authentication Credentialsapi_token=5D685159B6964FB69B044D3E7D2676D1True
surveypageID of page to add question toTrue
surveyquestionID of question to add sub-question toFalse
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, urlredirect, group, heatmap, texthighlighter, httpinsertFalse
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
properties[placeholder][English]**question placeholder text (open text questions)False
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
Heatmap PropertiesExampleRequired
properties[heatmap_image]https://url-of-your-image.jpgFalse
Text Highlighter PropertiesExampleRequired
properties[messages][th_content][English]This%20is%20the%20text%20to%20highlighterFalse
Http Insert Properties
Example
Required
properties[data_type]
response,fields (fields must be configured via the UI)
True
properties[url]
http%3A%2F%2Fwww.demo.testom%2Fwebhook.php
True

*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

**Required parameter - language version of the placeholder text must be specified.

Back to the Top

UPDATE SURVEYQUESTION - Update a specified surveyquestion.

https://restapi.surveygizmo.com/v5/survey/123456/surveyquestion/1?_method=POST

ParametersExampleRequired
Authentication Credentialsapi_token=5D685159B6964FB69B044D3E7D2676D1True
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
properties[placeholder][English]**
question placeholder text (open text questions)
False
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 variableFalse
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
Heatmap PropertiesExampleRequired
properties[heatmap_image]https://url-of-your-imageTrue
Text Highlighter PropertiesExampleRequired
properties[messages][th_content][English]This%20is%20the%20text%20to%20highlighterFalse
Http Insert Properties
Example
Required
properties[data_type]
response,fields (fields must be configured via the UI)
True
properties[url]
http%3A%2F%2Fwww.demo.testom%2Fwebhook.php
True

*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

**Required parameter - language version of the placeholder text must be specified.

DELETE SURVEYQUESTION - Delete a specified survey question.

https://restapi.surveygizmo.com/v5/survey/123456/surveyquestion/1?_method=DELETE

Deleting grid rows is not supported.
ParametersExampleRequired
Authentication Credentialsapi_token=5D685159B6964FB69B044D3E7D2676D1True