{"_id":"594445aaca04de003b4d8b8c","project":"55843604fd8d910d007b9502","version":{"_id":"558444ceafccfd0d00fcb2bb","forked_from":"55843604fd8d910d007b9505","project":"55843604fd8d910d007b9502","__v":55,"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"],"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":9,"slug":"surveys","title":"Surveys"},"user":"558435c2fb52ee0d0015d190","__v":3,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-06-16T20:55:06.771Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n  \"meta\": {\n    \"httpStatus\": \"200 - OK\",\n    \"requestId\": \"a4453116-ccdc-4456-9481-0fd7f9b34271\"\n  }\n}","language":"json","status":200}]},"settings":"","examples":{"codes":[{"code":"curl 'https://yourdatacenterid.qualtrics.com/API/v3/surveys/SV_012345678901234/permissions/collaborations' \\\n-X POST \\\n-H 'X-API-TOKEN: yourtokenhere' \\\n-H 'Content-Type: application/json' \\\n-d '\n    {\n    \"userId\" : \"UR_012345678901234\",\n    \"permissions\" : {\n      \"surveyDefinitionManipulation\" : {\n        \"copySurveyQuestions\" : true,\n        \"editSurveyFlow\" : true,\n        \"useBlocks\" : true,\n        \"useSkipLogic\" : true,\n        \"useConjoint\" : true,\n        \"useTriggers\" : true,\n        \"useQuotas\" : true,\n        \"setSurveyOptions\" : true,\n        \"editQuestions\" : true,\n        \"deleteSurveyQuestions\" : true\n       },\n\t\t\t\"surveyManagement\" : {\n        \"editSurveys\" : true,\n        \"activateSurveys\" : true,\n        \"deactivateSurveys\" : true,\n        \"copySurveys\" : true,\n        \"distributeSurveys\" : true,\n        \"deleteSurveys\" : true,\n        \"translateSurveys\" : true\n      },\n      \"response\" : {\n        \"editSurveyResponses\" : true,\n        \"createResponseSets\" : true,\n        \"viewResponseId\" : true,\n        \"useCrossTabs\" : true\n      },\n\t\t\t\"result\" : {\n        \"downloadSurveyResults\" : true,\n        \"viewSurveyResults\" : true,\n        \"filterSurveyResults\" : true,\n        \"viewPersonalData\" : true\n      }\n    }\n   }\n   '","language":"curl"}]},"method":"post","auth":"required","params":[{"_id":"59498e008a76f300263f38f0","ref":"","in":"body","required":true,"desc":"The userId of the account the survey is being shared to","default":"","type":"string","name":"userId"},{"_id":"59498e008a76f300263f38ef","ref":"","in":"body","required":true,"desc":"The various permissions being assigned to the user regarding the shared survey","default":"","type":"object","name":"permissions"},{"_id":"598352e979391c001e55918e","ref":"","in":"path","required":true,"desc":"Survey ID","default":"","type":"string","name":"surveyId"}],"url":"/v:version/surveys/:surveyId/permissions/collaborations"},"isReference":false,"order":7,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Limitations\",\n  \"body\": \"The userId must be in the same brand as the user sharing the survey\\n\\nAt the moment, surveys cannot be shared to groups\"\n}\n[/block]","excerpt":"Share a survey with another user in your brand","slug":"share-survey","type":"endpoint","title":"Share Survey"}

postShare Survey

Share a survey with another user in your brand

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

surveyId:
required
string
Survey ID

Body Params

userId:
required
string
The userId of the account the survey is being shared to
permissions:
required
object
The various permissions being assigned to the user regarding the shared survey

Examples


Result Format


Documentation

[block:callout] { "type": "info", "title": "Limitations", "body": "The userId must be in the same brand as the user sharing the survey\n\nAt the moment, surveys cannot be shared to groups" } [/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 }}