Update Survey Page
Updates a specified page in a survey. Any combination of title, description, and properties may be changed in a single call.
Endpoint
POST
v5/survey/{survey_id}/surveypage/{page_id}
Requires authentication
Path Parameters
Identifies the survey and specific page to update.
survey_id
string
required
The ID of the survey containing the page.
page_id
string
required
The ID of the page to update.
Query Parameters
All query parameters are optional. Include only the fields you want to change.
title
string
The updated title of the page.
description
string
The updated description text for the page.
properties
object
Configuration properties to update on the page.
child attributes
hidden
boolean
Set to
true to hide the page from respondents.piped_from
string
The ID of the question whose answer should be piped onto this page.
Response
Returns the updated survey page object.
result_ok
boolean
Whether the request succeeded.
data
object
The updated survey page object. See Get Survey Page for the full list of response fields.
child attributes
id
string
The unique ID of the page.
title
string
The updated title of the page.
description
string
The updated description text of the page.
properties
object
Configuration properties reflecting the current state of the page.
child attributes
hidden
boolean
Whether the page is hidden from respondents.
piped_from
string
The ID of the question whose answer is piped onto this page.
Examples
Request (cURL)
curl -X POST "https://api.alchemer.com/v5/survey/YOUR_SURVEY_ID/surveypage/YOUR_PAGE_ID?api_token=YOUR_API_TOKEN&api_token_secret=YOUR_API_TOKEN_SECRET&title=Updated+Page+Title"
Response
{
"result_ok": true,
"data": {
"id": "2",
"title": "Updated Page Title",
"description": "",
"properties": {
"hidden": false,
"piped_from": ""
}
}
}