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

Update

put
https://{host}/v2/surveys//custom-variables/

Updates a custom variable's name, label, or its unique / required settings. Every field is
optional: omit one to leave it unchanged. Renaming a variable changes the query-string key a
link has to carry, so links already in circulation stop supplying a value for it.

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

The survey id that owns the custom variable

int32
required

The custom variable id that you are updating

Body Params

Request body for updating a custom variable. Every field is optional: omit one to leave it unchanged.

string | null

The new 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. Omit to leave
unchanged.

string | null

The new display label used when reporting on the variable. Up to 250 characters. Omit to leave
unchanged.

boolean | null

Whether each response must supply a distinct value for this variable. Omit to leave unchanged.

boolean | null

Whether a value must be supplied before the survey can be taken. Omit to leave unchanged.

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