{"_id":"5a97340c77b85a0070e4ec70","project":"55843604fd8d910d007b9502","version":{"_id":"558444ceafccfd0d00fcb2bb","forked_from":"55843604fd8d910d007b9505","project":"55843604fd8d910d007b9502","__v":67,"createdAt":"2015-06-19T16:35:26.435Z","releaseDate":"2015-06-19T16:35:26.435Z","categories":["558444cfafccfd0d00fcb2bc","558444cfafccfd0d00fcb2bd","55ad4ce733616a0d00599d2e","55ad4cef6aadf20d0015b764","55ad4cf36aadf20d0015b765","55ad4cfb24cf160d0013584f","55ad4d0024cf160d00135850","55ad4d0a24cf160d00135851","55ad4d0d24cf160d00135852","55ad4d126aadf20d0015b766","55ad4d1624cf160d00135853","55ad4d1933616a0d00599d2f","55ad4d2233616a0d00599d30","55ad4d2e24cf160d00135854","55d35b6bf77e6d0d00b1b092","55d3649a0168850d0073f14a","55d366d40168850d0073f15a","55d37fcff77e6d0d00b1b13f","55d383e50168850d0073f1e1","55d3ac26c336ec0d007c2251","55d3c51cb2330119009c31db","55d3c59bfe37111900e536f3","55d3c5a7fe37111900e536f4","55d3c5b4fe37111900e536f5","55d3c5d4fe37111900e536f6","55d3c5d6b2330119009c31df","55d3c5d71f478b170077c164","55d3c687b2330119009c31e4","55d3c6a4fe37111900e536f9","55d3c6befe37111900e536fa","55d3c6e8d2c66f0d00497f93","55d49dcfd7c16b2d007de905","55d4ca8f5082980d0009c79b","55d4cab9c95a3d2f0069ad3d","55d4d279c95a3d2f0069ad60","55d4d9355082980d0009c7e1","55d4f6b5988e130d000b3eb1","55d64dc8e60a2f0d00b88ecb","5627ca43fcbbc621004ec07d","56c64a0d8f98b50d0012c37c","56f1b8b13eb62a34003ea041","56f1b9df4476fb2200795e8c","57f6907dca5e5d1700039ae9","591dd06ca266c423002ec4ca","59234825e465c11900922518","5936f82eaa591e0027638d57","59972f54fd7078001992c136","599c6da8f180820025f14909","59b054613c3e1b0019cf27d9","59b1ceca2d6231003ad73e5f","59b1cf1857911600382e0dc4","59b1cf2730f3d60010c30ef7","59b1cf385d4b89003035441a","59b1cf5857911600382e0dc6","59bc2c4e26ac9b0010a8b753","59bc2ce20b3eb30010657b70","59f0c793ba3bc90030f413ab","59f0cd62f5ecda00325294b9","59fb55a8e8d0f600101aedc3","59fcb05c067f8d0028613f86","5a2af4a1bc5fba00283909c1","5a83673b0e56010012138c12","5a972f2e77b85a0070e4ebe2","5aa300224ed4b40012c53e1d","5acd20095efd8d000359bb3c","5ad50889c05179000306021e","5af0927a8779670003daff34","5b55a46b282b25000319669e"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"category":{"_id":"5a972f2e77b85a0070e4ebe2","project":"55843604fd8d910d007b9502","version":"558444ceafccfd0d00fcb2bb","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-02-28T22:37:34.854Z","from_sync":false,"order":12,"slug":"survey-sessions","title":"Survey Sessions"},"user":"57bb969a36eff81700666822","githubsync":"","__v":21,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-02-28T22:58:20.537Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[{"code":"curl -X POST -H 'X-API-TOKEN: yourtokenhere' -H 'Content-Type: application/json' -d '{\n    \"language\": \"EN\",\n    \"embeddedData\": {\n           \"storeId\": \"48123\"\n    } \n}' 'https://yourdatacenter.qualtrics.com/API/v3/surveys/SV_eyRJDHHhxbvI6aN/sessions'\n","language":"curl"}]},"results":{"codes":[{"name":"","code":"{\n  \"result\": {\n    \"sessionId\": \"FS_1234567890\",\n    \"embeddedData\": {\n      \"edKey\": \"edValue\"\n    },\n    \"questions\": [\n      {\n        \"questionId\": \"QID1\",\n        \"type\": \"mc\",\n        \"display\": \"What is your favorite color?\",\n        \"options\": {\n          \"multiSelect\": false\n        },\n        \"choices\": [\n          {\n            \"choiceId\": \"1\",\n            \"display\": \"red\",\n            \"textual\": false\n          },\n          {\n            \"choiceId\": \"2\",\n            \"display\": \"green\",\n            \"textual\": false\n          },\n          {\n            \"choiceId\": \"3\",\n            \"display\": \"blue\",\n            \"textual\": false\n          }\n        ]\n      },\n      {\n        \"questionId\": \"QID3\",\n        \"type\": \"te\",\n        \"display\": \"Tell me why it's your favorite color\",\n        \"options\": {}\n      }\n    ],\n    \"responses\": {\n      \"QID1\": {\n        \"3\": {\n          \"selected\": true\n        }\n      }\n    },\n    \"done\": false\n  },\n  \"meta\": {\n    \"httpStatus\": \"201 - Created\",\n    \"requestId\": \"3184796f-93c6-4424-aad1-50b771872d9d\"\n  }\n}","language":"json","status":201},{"name":"","code":"{\n  \"meta\": {\n    \"httpStatus\": \"400 - Bad Request\",\n    \"error\": {\n      \"errorCode\": \"SVY-1.0\"\n      \"errorMessage\": \"Detailed error message\"\n    }\n  }\n}","language":"json","status":400},{"code":"{\n  \"meta\": {\n    \"httpStatus\": \"404 - Not Found\",\n    \"error\": {\n      \"errorCode\": \"SVY_1.2\"\n      \"errorMessage\": \"Detail error message\"\n    }\n  }\n}","language":"json","status":404}]},"settings":"","auth":"required","params":[{"_id":"5a97340c77b85a0070e4ec71","ref":"","in":"path","required":true,"desc":"Survey ID","default":"","type":"string","name":"surveyId"},{"_id":"5a97393e0614720012e4d232","ref":"","in":"body","required":false,"desc":"The language the survey should be taken in.","default":"","type":"string","name":"language"},{"_id":"5a97393e0614720012e4d231","ref":"","in":"body","required":false,"desc":"Any embedded data to set on the survey session.","default":"","type":"object","name":"embeddedData"},{"_id":"5a97393e0614720012e4d230","ref":"","in":"body","required":false,"desc":"A contact recipient id","default":"","type":"string","name":"recipientId"},{"_id":"5a97393e0614720012e4d22f","ref":"","in":"body","required":false,"desc":"A distribution id","default":"","type":"string","name":"distributionId"}],"url":"/v3/surveys/:surveyId/sessions"},"isReference":false,"order":0,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Documentation Change (9/17/18)\",\n  \"body\": \"Question field was incorrectly documented to have a \\\"maxSelectable\\\" option, the correct value is \\\"multiSelect\\\", which accepts a true/false value and is used for questions that accept multiple answers. There has been no change in functionality, just a correction to the documentation.\"\n}\n[/block]\nFor more information about using survey session APIs, see [Managing Survey Sessions](doc:managing-survey-sessions).","excerpt":"Start a survey session","slug":"create-session","type":"endpoint","title":"Create Session"}

postCreate Session

Start a survey session

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

surveyId:
required
string
Survey ID

Body Params

language:
string
The language the survey should be taken in.
embeddedData:
object
Any embedded data to set on the survey session.
recipientId:
string
A contact recipient id
distributionId:
string
A distribution id

Examples


Result Format


Documentation

[block:callout] { "type": "info", "title": "Documentation Change (9/17/18)", "body": "Question field was incorrectly documented to have a \"maxSelectable\" option, the correct value is \"multiSelect\", which accepts a true/false value and is used for questions that accept multiple answers. There has been no change in functionality, just a correction to the documentation." } [/block] For more information about using survey session APIs, see [Managing Survey Sessions](doc:managing-survey-sessions).

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}