{"_id":"5772e5dfda551f0e00be5c07","__v":4,"editedParams":true,"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"},"editedParams2":true,"project":"55843604fd8d910d007b9502","parentDoc":null,"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":16,"slug":"distributions","title":"Distributions"},"user":"558435c2fb52ee0d0015d190","updates":["59b17f0c376429003027e031"],"next":{"pages":[],"description":""},"createdAt":"2016-06-28T21:02:23.904Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"cURL (w/ mailingListId)","code":"curl -X POST -H 'X-API-TOKEN: yourapitoken' -H 'Content-Type: application/json' -d '{\n    \"surveyLink\": {\n    \t\"surveyId\":\"SV_0iEUsdE4aB4K0Dj\",\n      \"expirationDate\":\"2016-01-16T00:36:42Z\",\n      \"type\":\"Individual\"\n    },\n    \"header\": {\n    \t\"fromEmail\": \"apitest:::at:::qualtrics.com\",\n      \"fromName\": \"Api Tester\",\n      \"replyToEmail\": \"noreply@qualtrics.com\", \n      \"subject\": \"Example Subject\"\n    },\n    \"message\": {\n    \t\"libraryId\":\"UR_1M4aHozEkSxUfCl\",\n      \"messageId\":\"MS_0Vdgn7nLGSQBlYN\"\n    },\n    \"recipients\": {\n    \t\"mailingListId\":\"ML_01gl1yHFWKSU8y9\"\n    },\n    \"sendDate\": \"2015-11-17T00:36:42Z\"\n}' 'https://yourdatacenterid.qualtrics.com/API/v3/distributions'","language":"curl"},{"code":"curl -X POST -H 'X-API-TOKEN: yourapitoken' -H 'Content-Type: application/json' -d '{\n    \"surveyLink\": {\n    \t\"surveyId\":\"SV_0iEUsdE4aB4K0Dj\",\n      \"expirationDate\":\"2016-01-16T00:36:42Z\",\n      \"type\":\"Individual\"\n    },\n    \"header\": {\n    \t\"fromEmail\": \"apitest@qualtrics.com\",\n      \"fromName\": \"Api Tester\",\n      \"replyToEmail\": \"noreply@qualtrics.com\", \n      \"subject\": \"Example Subject\"\n    },\n    \"message\": {\n    \t\"libraryId\":\"UR_1M4aHozEkSxUfCl\",\n      \"messageId\":\"MS_0Vdgn7nLGSQBlYN\"\n    },\n    \"recipients\": {\n    \t\"mailingListId\":\"ML_01gl1yHFWKSU8y9\",\n      \"contactId\":\"MLRP_012345678901234\"  \n    },\n    \"sendDate\": \"2015-11-17T00:36:42Z\"\n}' 'https://yourdatacenterid.qualtrics.com/API/v3/distributions'","language":"curl","name":"cURL (w/ contactId)"},{"code":"curl -X POST -H 'X-API-TOKEN: yourapitoken' -H 'Content-Type: application/json' -d '{\n    \"surveyLink\": {\n    \t\"surveyId\":\"SV_0iEUsdE4aB4K0Dj\",\n      \"expirationDate\":\"2016-01-16T00:36:42Z\",\n      \"type\":\"Individual\"\n    },\n    \"header\": {\n    \t\"fromEmail\": \"apitest@qualtrics.com\",\n      \"fromName\": \"Api Tester\",\n      \"replyToEmail\": \"noreply@qualtrics.com\", \n      \"subject\": \"Example Subject\"\n    },\n    \"message\": {\n    \t\"libraryId\":\"UR_1M4aHozEkSxUfCl\",\n      \"messageId\":\"MS_0Vdgn7nLGSQBlYN\"\n    },\n    \"recipients\": {\n    \t\"mailingListId\":\"CG_01gl1yHFWKSU8y9\",\n      \"transactionId\":\"CTR_012345678901234\"\n    },\n    \"sendDate\": \"2015-11-17T00:36:42Z\"\n}' 'https://yourdatacenterid.qualtrics.com/API/v3/distributions'","language":"curl","name":"cURL (w/ transactionId)"},{"code":"curl -X POST -H 'X-API-TOKEN: yourapitoken' -H 'Content-Type: application/json' -d '{\n    \"surveyLink\": {\n    \t\"surveyId\":\"SV_0iEUsdE4aB4K0Dj\",\n      \"expirationDate\":\"2016-01-16T00:36:42Z\",\n      \"type\":\"Individual\"\n    },\n    \"header\": {\n    \t\"fromEmail\": \"apitest@qualtrics.com\",\n      \"fromName\": \"Api Tester\",\n      \"replyToEmail\": \"noreply@qualtrics.com\", \n      \"subject\": \"Example Subject\"\n    },\n    \"message\": {\n    \t\"libraryId\":\"UR_1M4aHozEkSxUfCl\",\n      \"messageId\":\"MS_0Vdgn7nLGSQBlYN\"\n    },\n    \"recipients\": {\n    \t\"mailingListId\":\"ML_01gl1yHFWKSU8y9\",\n      \"contactId\":\"CGC_012345678901234\"\n      # Do not use the CID (Directory level ID for contact), use CGC (The contactLookUpId key). \n      #You can find this by running the Target Audience Get Contact calls.\n      #\"contactLookupId\": \"CGC_012345678901234\".\n    },\n    \"sendDate\": \"2015-11-17T00:36:42Z\"\n}' 'https://yourdatacenterid.qualtrics.com/API/v3/distributions'","language":"curl","name":"cURL (TA w/ contactId)"}]},"method":"post","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"result\": {\n    \"id\": \"EMD_a4y9QGA0sGBRzmt\"\n  },\n  \"meta\": {\n    \"httpStatus\": \"200 - OK\"\n  }\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"55d3a3ad0168850d0073f324","ref":"","in":"body","required":true,"desc":"Time to send the email. See [Dates and Times](doc:dates-and-times) for more information on the date and time format.","default":"","type":"datetime","name":"sendDate"},{"_id":"55d3a3ad0168850d0073f322","ref":"","in":"body","required":true,"desc":"Email from address","default":"","type":"string","name":"header[fromEmail]"},{"_id":"55d3a3ad0168850d0073f321","ref":"","in":"body","required":true,"desc":"Email from name","default":"","type":"string","name":"header[fromName]"},{"_id":"55d3a3ad0168850d0073f320","ref":"","in":"body","required":false,"desc":"Email reply-to address","default":"fromEmail","type":"string","name":"header[replyToEmail]"},{"_id":"55d3a3ad0168850d0073f31f","ref":"","in":"body","required":true,"desc":"Email subject","default":"","type":"string","name":"header[subject]"},{"_id":"55d3a3ad0168850d0073f328","ref":"","in":"body","required":true,"desc":"Mailing List ID","default":"","type":"string","name":"recipients[mailingListId]"},{"_id":"55d3a3ad0168850d0073f326","ref":"","in":"body","required":false,"desc":"Contact ID","default":"","type":"string","name":"recipients[contactId]"},{"_id":"582e16c7d3eaed0f002e4da5","ref":"","in":"body","required":false,"desc":"You cannot provide both a **transactionId** and a **contactId**","default":"","type":"string","name":"recipients[transactionId]"},{"_id":"55d3a3ad0168850d0073f31e","ref":"","in":"body","required":true,"desc":"ID of the message. This is required in conjunction with the libraryId if no messageText is supplied.","default":"","type":"string","name":"message[messageId]"},{"_id":"57e5845f6dec2419008de60e","ref":"","in":"body","required":false,"desc":"A custom message text","default":"","type":"string","name":"message[messageText]"},{"_id":"5642709db48bdf19006a4d42","ref":"","in":"body","required":true,"desc":"Library ID of the message. This is required in conjunction with the libraryId if no messageText is supplied.","default":"","type":"string","name":"message[libraryId]"},{"_id":"55d3a3ad0168850d0073f323","ref":"","in":"body","required":true,"desc":"ID of the survey to send to recipients","default":"","type":"string","name":"surveyLink[surveyId]"},{"_id":"56427ec2b65f510d0035e51e","ref":"","in":"body","required":false,"desc":"If set it will use this date as the day the distribution will expire. See [Dates and Times](doc:dates-and-times) for more information on the date and time format. If it isn't set the default expiration date for all links is 60 days.","default":"","type":"datetime","name":"surveyLink[expirationDate]"},{"_id":"56427ec2b65f510d0035e51d","ref":"","in":"body","required":false,"desc":"The type of link that will be sent out. Possible values are: [Individual, Multiple, Anonymous]. If Individual, one unique link for each recipient will be generated that can be taken one time. If Multiple, then a unique link is sent out to each recipient that can be taken multiple times. If Anonymous, then the same generic link is sent to all recipients and can be taken multiple times. Possible values are: Individual, Multiple, Anonymous","default":"Individual","type":"string","name":"surveyLink[type]"}],"url":"/v:version/distributions"},"isReference":false,"order":2,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Default Expiration Date\",\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 surveyLink object in the body of your request. Please see the cURL example.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Target Audience -  Single Contact Distributions\",\n  \"body\": \"When sending a survey to a single Target Audience contact, be sure pass the CGC (Contact Mailing List ID, declared in the API as \\\"contactLookupId\\\") to the \\\"contactId\\\" key in the \\\"recipients\\\" object and NOT the CID (Contact's Directory Level ID). \\n\\nYou can find the \\\"contactLookUpId\\\" in any of the Target Audience Get Contact calls.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Unfortunately this feature will not work with this API call. We recommend using Postman to test this call.\",\n  \"title\": \"Try It Out Feature Limitation\"\n}\n[/block]","excerpt":"Create a new survey distribution","slug":"create-survey-distribution","type":"endpoint","title":"Create Survey Distribution"}

postCreate Survey Distribution

Create a new survey distribution

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

sendDate:
required
datetime
Time to send the email. See [Dates and Times](doc:dates-and-times) for more information on the date and time format.
header[fromEmail]:
required
string
Email from address
header[fromName]:
required
string
Email from name
header[replyToEmail]:
stringfromEmail
Email reply-to address
header[subject]:
required
string
Email subject
recipients[mailingListId]:
required
string
Mailing List ID
recipients[contactId]:
string
Contact ID
recipients[transactionId]:
string
You cannot provide both a **transactionId** and a **contactId**
message[messageId]:
required
string
ID of the message. This is required in conjunction with the libraryId if no messageText is supplied.
message[messageText]:
string
A custom message text
message[libraryId]:
required
string
Library ID of the message. This is required in conjunction with the libraryId if no messageText is supplied.
surveyLink[surveyId]:
required
string
ID of the survey to send to recipients
surveyLink[expirationDate]:
datetime
If set it will use this date as the day the distribution will expire. See [Dates and Times](doc:dates-and-times) for more information on the date and time format. If it isn't set the default expiration date for all links is 60 days.
surveyLink[type]:
stringIndividual
The type of link that will be sent out. Possible values are: [Individual, Multiple, Anonymous]. If Individual, one unique link for each recipient will be generated that can be taken one time. If Multiple, then a unique link is sent out to each recipient that can be taken multiple times. If Anonymous, then the same generic link is sent to all recipients and can be taken multiple times. Possible values are: Individual, Multiple, Anonymous

Examples


Result Format


Documentation

[block:callout] { "type": "info", "title": "Default Expiration Date", "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 surveyLink object in the body of your request. Please see the cURL example." } [/block] [block:callout] { "type": "warning", "title": "Target Audience - Single Contact Distributions", "body": "When sending a survey to a single Target Audience contact, be sure pass the CGC (Contact Mailing List ID, declared in the API as \"contactLookupId\") to the \"contactId\" key in the \"recipients\" object and NOT the CID (Contact's Directory Level ID). \n\nYou can find the \"contactLookUpId\" in any of the Target Audience Get Contact calls." } [/block] [block:callout] { "type": "warning", "body": "Unfortunately this feature will not work with this API call. We recommend using Postman to test this call.", "title": "Try It Out Feature Limitation" } [/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 }}