Create Survey Response
Creates a new response for the specified survey, optionally pre-populating one or more question answers.
Endpoint
PUT
v5/survey/{survey_id}/surveyresponse
Requires authentication
Path Parameters
The survey for which the response will be created.
survey_id
string
required
The ID of the survey to create a response for.
Query Parameters
status
string
The status to set on the response. Accepted values:
Complete, Partial, Disqualified.data
object
required
Keyed object of question answers to populate. Each key is either the question's numeric ID or its shortname — both are interchangeable. At least one data parameter is required.
child attributes
value
string
Populates an open-text question. Example:
data[1][value]=Response text or data[Shortname][value]=Response text.
option SKU
string
Populates a select-type question using the option's SKU. The value should be the option title or reporting value. Example:
data[1][10001]=Yes or data[Shortname][10001]=Yes. When the reporting value for a checkbox question contains a comma, it must be URL-encoded.
option SKU-other
string
Populates the “Other” text field for a select question. Example:
data[1][10005-other]=Response text.
comment
string
Populates the comment field for a question. Example:
data[1][comment]=Response text.
supported question types
Response
Returns the result of the creation request and the full response object.
result_ok
boolean
Whether the request succeeded.
data
object
The newly created survey response object.
child attributes
id
string
The unique ID of the newly created response.
contact_id
string
The contact ID associated with the response, if any.
status
string
The response status. Possible values:
Complete, Partial, Disqualified.is_test_data
string
Whether this response is flagged as test data.
"1" = test, "0" = real.date_submitted
string
Timestamp when the response was submitted (EST/EDT).
date_updated
string
Timestamp when the response was last updated.
date_started
string
Timestamp when the respondent began the survey (EST/EDT).
session_id
string
Unique session identifier for the response.
language
string
Language the survey was taken in.
link_id
string
The ID of the survey campaign link used to access the survey.
url_variables
array
Any URL variables passed in when the survey was accessed. Empty array if none.
ip_address
string
IP address of the respondent.
referer
string
The URL the respondent came from when starting the survey.
user_agent
string
Browser/device user agent string of the respondent.
response_time
integer
Time in seconds the respondent spent on the survey.
data_quality
array | object
Data quality flags for the response. Returns an empty array
[] if no issues are detected.longitude
string
Estimated longitude of the respondent based on IP geolocation.
latitude
string
Estimated latitude of the respondent based on IP geolocation.
country
string
Country of the respondent based on IP geolocation.
city
string
City of the respondent based on IP geolocation.
region
string
State or region of the respondent based on IP geolocation.
postal
string
Postal code of the respondent based on IP geolocation.
dma
string
Designated Market Area code based on IP geolocation.
survey_data
object
Keyed object of question response data, where each key is the question ID. Contains one entry per question in the survey.
child attributes
id
integer
The question ID.
type
string
The question type (e.g.
TEXTBOX, ESSAY, HIDDEN).question
string
The question title or label.
section_id
integer
The page/section ID the question belongs to.
answer
string | null
The respondent's answer. Returns
null if not answered or not shown.shown
boolean
Whether the question was shown to the respondent.
Examples
Request (cURL)
curl -X PUT "https://api.alchemer.com/v5/survey/12345/surveyresponse/?api_token=YOUR_API_TOKEN&api_token_secret=YOUR_API_TOKEN_SECRET&data[2][value]=John&data[3][value]=Smith"
Response
{
"result_ok": true,
"data": {
"id": "94",
"contact_id": "",
"status": "Complete",
"is_test_data": "0",
"date_submitted": "2026-03-25 16:53:09 EDT",
"date_updated": "2026-03-25 16:53:09",
"session_id": "1774471989_69c44b350d8135.54354437",
"language": "English",
"date_started": "2026-03-25 16:53:09 EDT",
"link_id": null,
"url_variables": [],
"ip_address": "204.132.224.66",
"referer": null,
"user_agent": "SurveyGizmo REST API",
"response_time": null,
"data_quality": [],
"longitude": "-105.01560211182",
"latitude": "39.907299041748",
"country": "United States",
"city": "Denver",
"region": "CO",
"postal": "80234",
"dma": "751",
"survey_data": {
"2": {
"id": 2,
"type": "TEXTBOX",
"question": "First Name",
"section_id": 1,
"answer": "John",
"shown": true
},
"3": {
"id": 3,
"type": "TEXTBOX",
"question": "Last Name",
"section_id": 1,
"answer": "Smith",
"shown": false
}
}
}
}