HomeGuidesAPI Reference
API Reference
  1. SS Public API
  2. SurveyCustomVariables

Insert

post
https://{host}/v2/surveys//customvariables

Adds a custom variable to a survey. The name is the key a respondent's link carries on the query
string, so it allows letters, digits and underscores only and must be unique within the survey;
the label is the wording used when reporting on the variable.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

The survey id to add the custom variable to

Body Params

Request body for creating a custom variable on a survey.

string | null

The variable name as passed on the survey url query string. Letters, digits and underscores only,
up to 50 characters, unique within the survey, and not a reserved name.

string | null

The display label used when reporting on the variable. Up to 250 characters.

boolean

Whether each response must supply a distinct value for this variable. Defaults to false.

boolean

Whether a value must be supplied before the survey can be taken. Defaults to false.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated about 4 hours ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated about 4 hours ago