Create Survey Page
Creates a new page in the specified survey.
Endpoint
PUT
v5/survey/{survey_id}/surveypage
Requires authentication
Path Parameters
The survey to add the page to.
survey_id
string
required
The ID of the survey to create a page in.
Query Parameters
title
string
required
The title of the new page.
description
string
Description text to display on the page.
after
string
The ID of the page this new page should follow. Use to control insertion order.
properties
object
Configuration properties to set 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 result of the creation request and the newly created page object.
result_ok
boolean
Whether the request succeeded.
data
object
The newly created survey page object.
child attributes
id
string
The unique ID assigned to the newly created page.
title
string
The title of the page.
description
string
The description text of the page.
properties
object
Configuration properties set on 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 PUT "https://api.alchemer.com/v5/survey/YOUR_SURVEY_ID/surveypage?api_token=YOUR_API_TOKEN&api_token_secret=YOUR_API_TOKEN_SECRET&title=My+New+Page"
Response
{
"result_ok": true,
"data": {
"id": "4",
"title": "My New Page",
"description": "",
"properties": {
"hidden": false,
"piped_from": ""
}
}
}