Start a New Session
POST {{baseUrl}}/surveys/:surveyId/sessions
A sessionId is returned which is used for subsequent requests.
<!--From Readme-->
This API uses a 10-second timeout instead of the default timeout.
Limited Question Types Allowed
This API is limited to surveys with Multiple Choice, Text Entry, and NPS questions. Surveys with other question types are incompatible with this API.
For more information about using survey session APIs, see Working with Survey Sessions.
Request Body
{"language"=>"EN", "embeddedData"=>{"edKey"=>"edValue", "customerName"=>"Kyle"}, "recipientId"=>"MLRP_1234567890", "distributionId"=>"EMD_1234567890"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"result":{"sessionId":"FS_1234567890","embeddedData":{"edKey":"edValue","customerName":"Kyle"},"questions":[{"questionId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"display":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"choices":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"options":{"columnLabels":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"multiSelect":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},{"questionId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"display":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"choices":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"options":{"columnLabels":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"multiSelect":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}}],"responses":{"do_84":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"sed2":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"et_09":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"sit_a":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"done":"amet"},"meta":{"httpStatus":"exercitation aute ad in","requestId":"occaecat reprehenderit ea eiusmod ad","notice":"cupidatat do est"}}