Update a Session
POST {{baseUrl}}/surveys/:surveyId/sessions/:sessionId
Updates the session with response data. Optionally, may trigger movement through the survey flow. <!--From Readme--> <!-- theme: info -->
For more information about using survey session APIs, see Working With Survey Sessions.
The
advance
andclose
parameters in the request body are mutually exclusive.The
advance
property and theclose
parameters are mutually exclusive parameters. Your request will fail if you include both parameters in your request.
Request Body
{"advance"=>true, "embeddedData"=>{"edKey"=>"edValue", "customerName"=>"Kyle"}, "responses"=>{"culpa4_"=>{"Duis_"=>{"selected"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "text"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}}}, "close"=>true}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"result":{},"meta":{"httpStatus":"mollit voluptate ad aute velit","requestId":"sed qui","notice":"exercitation minim aute occaecat pariatur"}}