{"_id":"57abb2a1b5c9591700b879c1","__v":10,"version":{"_id":"558444ceafccfd0d00fcb2bb","forked_from":"55843604fd8d910d007b9505","project":"55843604fd8d910d007b9502","__v":66,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"category":{"_id":"55d3c6befe37111900e536fa","pages":["56c25610c866aa1700109ad7"],"version":"558444ceafccfd0d00fcb2bb","__v":1,"project":"55843604fd8d910d007b9502","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-18T23:58:54.366Z","from_sync":false,"order":21,"slug":"distributions","title":"Distributions"},"project":"55843604fd8d910d007b9502","user":"57ab8375f68f6e1900a8ab9c","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-08-10T23:02:57.038Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl -X POST -H 'X-API-TOKEN: yourapitoken' -H 'Content-Type: application/json' -d '{\n\"action\": \"CreateDistribution\",\n\"surveyId\": \"Your_Survey_Id\",\n\"mailingListId\": \"Your_MailingList_Id\",\n\"description\": \"This is a test distribution\",\n\"expirationDate\": \"2016-12-03 11:22:33\",\n\"linkType\": \"Individual\"\n}' 'https://yourdatacenterid.qualtrics.com/API/v3/distributions'"}]},"method":"post","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"result\": {\n        \"id\": \"EMD_8Rw2wG4TzUMNTsp\"\n    },\n    \"meta\": {\n        \"httpStatus\": \"200 - OK\",\n        \"requestId\": \"dd34591a-9db7-4afa-a047-9afb094465d7\"\n    }\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"55d3a3ad0168850d0073f328","ref":"","in":"body","required":true,"desc":"Mailing List ID","default":"","type":"string","name":"mailingListId"},{"_id":"55d3a3ad0168850d0073f323","ref":"","in":"body","required":true,"desc":"ID of the survey to send to recipients","default":"","type":"string","name":"surveyId"},{"_id":"55d3a3ad0168850d0073f31f","ref":"","in":"body","required":true,"desc":"Describe the distribution","default":"","type":"string","name":"description"},{"_id":"57b75739480bae1900ce4e66","ref":"","in":"body","required":true,"desc":"To generate a distribution links, value must be **CreateDistribution**","default":"CreateDistribution","type":"string","name":"action"},{"_id":"5808e53ab2524d0f003506b4","ref":"","in":"body","required":false,"desc":"If set, it will use this date as the day and time (the provided date will be interpreted as Mountain Time) the distribution will expire, format: **yyyy-MM-dd HH:mm:ss**. If not set, the expiration date for all links will be set to 60 days after creation.","default":"","type":"string","name":"expirationDate"},{"_id":"5808e53ab2524d0f003506b3","ref":"","in":"body","required":false,"desc":"Allowed values: **Individual**, **Multiple**, **Anonymous**. The type of link that will be associated with the distribution. If **Individual** (default) one unique link for each recipient will be generated that can be taken one time. If **Multiple** then a unique link is generated for each recipient that can be taken multiple times. If **Anonymous** then the same generic link is associated with all recipients and can be taken multiple times.","default":"Individual","type":"string","name":"linkType"},{"_id":"597bb2c1f77ce2001be95d8e","ref":"","in":"body","required":false,"desc":"The library that **mailingListId** belongs to. If this value is not provided, it will default to the library of the user associated with the token provided in the **X-API-TOKEN** request header. You must have permissions to access the library and the other resources associated with it.","default":"","type":"string","name":"libraryId"}],"url":"/v:version/distributions"},"isReference":false,"order":6,"body":"Use the _id_ found in the API result as the _distributionId_ in [Get Distribution Links](doc:get-distribution-links) to retrieve individual distribution links after the distribution invite is generated.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"The default expiration date for all links is 60 days. You can add a custom expiration date to your survey links by the expirationDate parameter in the body of your request. Please see the cURL example.\",\n  \"title\": \"Default Expiration Date\"\n}\n[/block]","excerpt":"Create a distribution without sending any emails. The created distribution will be of type \"GeneratedInvite\". The survey must be active before you can generate a distribution invite. Refer to the documentation below for further information regarding usage of this API's result.","slug":"generate-distribution-invite","type":"endpoint","title":"Generate Distribution Links"}

postGenerate Distribution Links

Create a distribution without sending any emails. The created distribution will be of type "GeneratedInvite". The survey must be active before you can generate a distribution invite. Refer to the documentation below for further information regarding usage of this API's result.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

mailingListId:
required
string
Mailing List ID
surveyId:
required
string
ID of the survey to send to recipients
description:
required
string
Describe the distribution
action:
required
stringCreateDistribution
To generate a distribution links, value must be **CreateDistribution**
expirationDate:
string
If set, it will use this date as the day and time (the provided date will be interpreted as Mountain Time) the distribution will expire, format: **yyyy-MM-dd HH:mm:ss**. If not set, the expiration date for all links will be set to 60 days after creation.
linkType:
stringIndividual
Allowed values: **Individual**, **Multiple**, **Anonymous**. The type of link that will be associated with the distribution. If **Individual** (default) one unique link for each recipient will be generated that can be taken one time. If **Multiple** then a unique link is generated for each recipient that can be taken multiple times. If **Anonymous** then the same generic link is associated with all recipients and can be taken multiple times.
libraryId:
string
The library that **mailingListId** belongs to. If this value is not provided, it will default to the library of the user associated with the token provided in the **X-API-TOKEN** request header. You must have permissions to access the library and the other resources associated with it.

Examples


Result Format


Documentation

Use the _id_ found in the API result as the _distributionId_ in [Get Distribution Links](doc:get-distribution-links) to retrieve individual distribution links after the distribution invite is generated. [block:callout] { "type": "info", "body": "The default expiration date for all links is 60 days. You can add a custom expiration date to your survey links by the expirationDate parameter in the body of your request. Please see the cURL example.", "title": "Default Expiration Date" } [/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 }}