Update Survey Option
Updates a specified option for a survey question. Any combination of title, reporting value, position, and properties may be changed in a single call.
Endpoint
POST
v5/survey/{survey_id}/surveyquestion/{question_id}/surveyoption/{option_id}
Requires authentication
Path Parameters
Identifies the survey, question, and specific option to update.
survey_id
string
required
The ID of the survey containing the question.
question_id
string
required
The ID of the question containing the option.
option_id
string
required
The ID (SKU) of the option to update.
Query Parameters
All query parameters are optional. Include only the fields you want to change.
title
string
The updated display text of the option.
value
string
The updated reporting value of the option.
after
string
The ID of the option this option should follow. Use to reposition the option.
properties
object
Configuration properties to update on the option.
child attributes
disabled
boolean
Set to
true to disable this option and hide it from respondents.dependent
string
Comma-separated question IDs for trigger questions this option depends on.
other
boolean
Set to
true to add an open-text “Other” field to this option.requireother
boolean
Set to
true to require a response in the “Other” text field when this option is selected.na
boolean
Set to
true to designate this option as a “Not Applicable” choice.none
boolean
Set to
true to designate this option as a “None” choice.all
boolean
Set to
true to designate this option as a “Select All” choice.fixed
boolean
Set to
true to pin this option to a fixed position when randomization is enabled.heatmap-color
string
Hex color code (without
#) used to represent this option in heatmap reports. Example: f06486.Response
Returns the updated survey option object.
result_ok
boolean
Whether the request succeeded.
data
object
The updated survey option object. See Get Survey Option for the full list of response fields.
child attributes
id
string
The unique ID (SKU) of the option.
title
string
The updated display text of the option.
value
string
The updated reporting value of the option.
properties
object
Configuration properties reflecting the current state of the option.
child attributes
dependent
string
Trigger question IDs, if set.
other
boolean
Whether an open-text “Other” field is attached.
requireother
boolean
Whether the “Other” field is required.
na
boolean
Whether the option is a “Not Applicable” choice.
none
boolean
Whether the option is a “None” choice.
all
boolean
Whether the option is a “Select All” choice.
fixed
boolean
Whether the option is pinned to a fixed position.
heatmap-color
string
Hex color code for heatmap reports, if set.
Examples
Request (cURL)
curl -X POST "https://api.alchemer.com/v5/survey/YOUR_SURVEY_ID/surveyquestion/YOUR_QUESTION_ID/surveyoption/YOUR_OPTION_ID?api_token=YOUR_API_TOKEN&api_token_secret=YOUR_API_TOKEN_SECRET&title=Updated+Option+Title&value=updated_value"
Response
{
"result_ok": true,
"data": {
"id": 10001,
"title": {
"English": "Updated Option Title"
},
"value": "updated_value",
"properties": {
"disabled": false,
"other": false
}
}
}