{"_id":"59d6b594971587001aa3cb38","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":"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":11,"slug":"surveys","title":"Surveys"},"user":"593b124cf1899900199970b9","githubsync":"","__v":11,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-10-05T22:43:32.841Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n    \"meta\": {\n        \"httpStatus\": \"200 - OK\",\n        \"requestId\": \"9d414e9b-0f09-4555-a206-4fe9d817d8b8\"\n    }\n}","language":"json","status":200},{"name":"","code":"{\n    \"meta\": {\n        \"httpStatus\": \"400 - Bad Request\",\n        \"error\": {\n            \"errorMessage\": \"Element at index 0 of input list is improperly formatted. Check that it is a JSON object with a field named 'key'.\",\n            \"errorCode\": \"EDF_2.0\"\n        },\n        \"requestId\": null\n    }\n}","language":"json","status":400}]},"settings":"","examples":{"codes":[{"code":"curl -X POST \\\n  https://yourdatacenterid.qualtrics.com/API/v3/surveys/SV_8DtnNEqG82odRZz/embeddeddatafields \\\n  -H 'content-type: application/json' \\\n  -H 'x-api-token: yourtokenhere' \\\n  -d '{\n\t\"embeddedDataFields\": [\n\t\t{ \"key\": \"key2\", \"value\": \"value2\", \"type\": \"multiValueTextSet\" },\n\t\t{ \"key\": \"key3\", \"value\": \"value3\", \"type\": \"numberSet\" }\n\t]\n}'","language":"text","name":"cURL"}]},"method":"post","auth":"required","params":[{"_id":"59d6b7a2971587001aa3cb3e","ref":"","in":"path","required":false,"desc":"The survey ID of the survey you want to insert embedded data fields into.","default":"","type":"string","name":"surveyId"},{"_id":"59d6b7a2971587001aa3cb3d","ref":"","in":"body","required":false,"desc":"An array of objects representing the specifications for the embedded data fields you want to insert. See below for examples and a description of what fields are allowed/required.","default":"","type":"array_object","name":"embeddedDataFields"}],"url":"/v3/surveys/:surveyId/embeddeddatafields"},"isReference":false,"order":8,"body":"**Specification for embedded data fields**\n\nEach object MUST contain a field named \"key\", which will be the name of your embedded data field. If this field is absent from any object, none of the embedded data fields will be inserted into the survey and an error will be returned specifying which embedded data field is malformed. Each object may also contain a field named \"value\", which will provide a default value for your embedded data field. Lastly, you may include a field named \"type\" (defaults to \"textSet\" if not provided) to indicate the type of embedded data field. This type must be a valid type as specified in the table below. If any embedded data field has an invalid type, none of them will be inserted and an error will be thrown. All other fields will be ignored.\n\n**Valid embedded data field types:** \n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"text\",\n    \"h-1\": \"Type name in UI\",\n    \"0-1\": \"Text\",\n    \"1-0\": \"textSet\",\n    \"h-0\": \"Type passed to API\",\n    \"1-1\": \"Text Set\",\n    \"2-0\": \"number\",\n    \"2-1\": \"Number\",\n    \"3-0\": \"numberSet\",\n    \"3-1\": \"Number Set\",\n    \"4-0\": \"multiValueTextSet\",\n    \"4-1\": \"Multi-Value Text Set\",\n    \"5-0\": \"date\",\n    \"5-1\": \"Date\",\n    \"6-0\": \"filterOnly\",\n    \"6-1\": \"FilterOnly\"\n  },\n  \"cols\": 2,\n  \"rows\": 7\n}\n[/block]","excerpt":"","slug":"insert-embedded-data-fields","type":"endpoint","title":"Insert Embedded Data Fields"}

postInsert Embedded Data Fields


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

surveyId:
string
The survey ID of the survey you want to insert embedded data fields into.

Body Params

embeddedDataFields:
array of objects
An array of objects representing the specifications for the embedded data fields you want to insert. See below for examples and a description of what fields are allowed/required.

Examples


Result Format


Documentation

**Specification for embedded data fields** Each object MUST contain a field named "key", which will be the name of your embedded data field. If this field is absent from any object, none of the embedded data fields will be inserted into the survey and an error will be returned specifying which embedded data field is malformed. Each object may also contain a field named "value", which will provide a default value for your embedded data field. Lastly, you may include a field named "type" (defaults to "textSet" if not provided) to indicate the type of embedded data field. This type must be a valid type as specified in the table below. If any embedded data field has an invalid type, none of them will be inserted and an error will be thrown. All other fields will be ignored. **Valid embedded data field types:** [block:parameters] { "data": { "0-0": "text", "h-1": "Type name in UI", "0-1": "Text", "1-0": "textSet", "h-0": "Type passed to API", "1-1": "Text Set", "2-0": "number", "2-1": "Number", "3-0": "numberSet", "3-1": "Number Set", "4-0": "multiValueTextSet", "4-1": "Multi-Value Text Set", "5-0": "date", "5-1": "Date", "6-0": "filterOnly", "6-1": "FilterOnly" }, "cols": 2, "rows": 7 } [/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 }}