Start a new response
POST/v3/responses/new
Partial submission settings for the survey must be enabled to use this endpoint
Request
- application/json
 
Body
survey_id numberrequired
ID of the survey
contact_id number
ID of the contact
channel_id number
ID of the channel
meta_data
object
os string
Possible values: <= 255 characters
OS of the response
browser string
Possible values: <= 255 characters
Browser of response
time_zone string
Possible values: <= 255 characters
Time Zone of response
browser_language string
Possible values: <= 255 characters
Browser Language of the response
date_time date
Date and Time of submission. Should be in the ISO format
Responses
- 200
 
Successful
- */*
 
- Schema
 - Example (from schema)
 
Schema
data
object
id numberrequired
ID of the response
state stringrequired
State of the response
start_time stringrequired
Start Time of the response
{
  "data": {
    "id": 1,
    "state": "STARTED",
    "start_time": "string"
  }
}
Loading...