{"_id":"57028be9adbd340e00928bc6","editedParams2":true,"__v":1,"version":{"_id":"558444ceafccfd0d00fcb2bb","forked_from":"55843604fd8d910d007b9505","project":"55843604fd8d910d007b9502","__v":46,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"parentDoc":null,"editedParams":true,"project":"55843604fd8d910d007b9502","user":"558435c2fb52ee0d0015d190","category":{"_id":"558444cfafccfd0d00fcb2bd","pages":["558444cfafccfd0d00fcb2be","558444cfafccfd0d00fcb2bf","55ad50d524cf160d00135877","55ad50ed33616a0d00599d4e","55ad511833616a0d00599d50","55ad51446aadf20d0015b784","55ad516033616a0d00599d52","55ad516e33616a0d00599d54","55ad517d24cf160d00135879","55ad771933616a0d00599e16","55d34b160168850d0073f09f","55d34d0df77e6d0d00b1b02f","55d3523ff77e6d0d00b1b059","55d35450b9ef4435006dece4","55d3549a0168850d0073f0db","55d354aa0168850d0073f0dc","55d354f20168850d0073f0df","55d3552e0168850d0073f0e2","55d35558b9ef4435006decef","55d35575f77e6d0d00b1b06f","55d355a2b9ef4435006decf3","56df156a3df5cb2000bb994b"],"project":"55843604fd8d910d007b9502","__v":21,"version":"558444ceafccfd0d00fcb2bb","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-06-19T16:24:31.047Z","from_sync":false,"order":7,"slug":"surveys","title":"Surveys"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-04T15:44:41.739Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[{"code":"{\n  \"result\": {\n\t\t\"id\":\"SV_012345678912345\"\n  },\n  \"meta\": {\n   \"httpStatus\":\"200 - OK\"\n }\n}","name":"","status":200,"language":"json"},{"code":"{\n    \"meta\": {\n        \"error\": {\n            \"errorCode\": \"RP_10\",\n            \"errorMessage\": \"Expected param not found: name\"\n        },\n        \"httpStatus\": \"400 - Bad Request\",\n        \"requestId\": null\n    }\n}\n","language":"json","status":400}]},"settings":"","examples":{"codes":[{"code":"curl -H 'X-API-TOKEN: yourapitoken' \\\n\t-F 'name=Test' \\\n\t-F 'file=:::at:::/path/to/MySurvey.qsf;type=application/vnd.qualtrics.survey.qsf' \\\n\t'https://yourdatacenterid.qualtrics.com/API/v3/surveys'","language":"curl"}]},"auth":"required","params":[{"_id":"55ad7792f302af23000abf58","ref":"","in":"body","required":true,"desc":"Name of the new survey","default":"","type":"string","name":"name"},{"_id":"56df15c2b187fb170024fb92","ref":"","in":"body","required":true,"desc":"The file data to be imported.","default":"","type":"file","name":"file"},{"_id":"55ad7792f302af23000abf57","ref":"","in":"body","required":false,"desc":"Owner of the new survey","default":"","type":"string","name":"ownerId"}],"url":"/v:version/surveys"},"isReference":false,"order":4,"body":"The Content-Type for this api call must be \"multipart/form-data\".\n\nAllowed content types for files to be imported:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"File Type\",\n    \"0-0\": \"qsf\",\n    \"h-1\": \"Content Type\",\n    \"0-1\": \"application/vnd.qualtrics.survey.qsf\",\n    \"h-2\": \"Description\",\n    \"0-2\": \"Not user editable. This format preserves the entire state of a survey.\",\n    \"1-1\": \"application/vnd.qualtrics.survey.txt\",\n    \"2-1\": \"application/vnd.qualtrics.survey.doc\",\n    \"1-0\": \"txt\",\n    \"1-2\": \"A simple user editable survey format.\",\n    \"2-2\": \"Simplified Qualtrics surveys represented as a Microsoft Word Document.\",\n    \"2-0\": \"doc\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\nFor more information about using the survey APIs, see [Managing Surveys](doc:managing-surveys).\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Try It Out Feature Limitation\",\n  \"body\": \"Unfortunately, Try It Out will not let you upload files. Postman also cannot run multipart requests for custom file types (like CSV or QSF). To test this feature, it's suggested you run the cURL example.\"\n}\n[/block]","excerpt":"Creates a new survey via a multipart upload","slug":"import-survey-1","type":"endpoint","title":"Import Survey"}

postImport Survey

Creates a new survey via a multipart upload

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

name:
required
string
Name of the new survey
file:
required
file
The file data to be imported.
ownerId:
string
Owner of the new survey

Examples


Result Format


Documentation

The Content-Type for this api call must be "multipart/form-data". Allowed content types for files to be imported: [block:parameters] { "data": { "h-0": "File Type", "0-0": "qsf", "h-1": "Content Type", "0-1": "application/vnd.qualtrics.survey.qsf", "h-2": "Description", "0-2": "Not user editable. This format preserves the entire state of a survey.", "1-1": "application/vnd.qualtrics.survey.txt", "2-1": "application/vnd.qualtrics.survey.doc", "1-0": "txt", "1-2": "A simple user editable survey format.", "2-2": "Simplified Qualtrics surveys represented as a Microsoft Word Document.", "2-0": "doc" }, "cols": 3, "rows": 3 } [/block] For more information about using the survey APIs, see [Managing Surveys](doc:managing-surveys). [block:callout] { "type": "warning", "title": "Try It Out Feature Limitation", "body": "Unfortunately, Try It Out will not let you upload files. Postman also cannot run multipart requests for custom file types (like CSV or QSF). To test this feature, it's suggested you run the cURL example." } [/block]

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 }}