{"_id":"57028f91adbd340e00928bd8","parentDoc":null,"project":"55843604fd8d910d007b9502","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":18,"slug":"distributions","title":"Distributions"},"version":{"_id":"558444ceafccfd0d00fcb2bb","forked_from":"55843604fd8d910d007b9505","project":"55843604fd8d910d007b9502","__v":60,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"editedParams":true,"user":"558435c2fb52ee0d0015d190","__v":5,"editedParams2":true,"updates":["573f279e7eeb8b190094ca7f"],"next":{"pages":[],"description":""},"createdAt":"2016-04-04T16:00:17.274Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  \"result\": {\n    \"id\": \"EMD_a4y9QGA0sGBRzmt\"\n  },\n  \"meta\": {\n    \"httpStatus\": \"200 - OK\"\n  }\n}"}]},"settings":"","examples":{"codes":[{"code":"curl -X POST -H 'X-API-TOKEN: yourapitoken' -H 'Content-Type: application/json' -d '{\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\"messageText\":\"This is my custom message.\"\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"}]},"method":"post","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":"","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":"5978fe73879a7e001b896b56","ref":"","in":"body","required":false,"desc":"Contact ID","default":"","type":"string","name":"recipients[contactId]"},{"_id":"5642709db48bdf19006a4d41","ref":"","in":"body","required":true,"desc":"A custom message text","default":"","type":"string","name":"message[messageText]"}],"url":"/v:version/distributions"},"isReference":false,"order":9,"body":"[block:callout]\n{\n  \"type\": \"warning\",\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  \"title\": \"Target Audience - Single Contact Distributions\"\n}\n[/block]","excerpt":"Create a new distribution with a custom message","slug":"create-distribution","type":"endpoint","title":"Send Email to Mailing List"}

postSend Email to Mailing List

Create a new distribution with a custom message

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]:
string
Email reply-to address
header[subject]:
required
string
Email subject
recipients[mailingListId]:
required
string
Mailing List ID
recipients[contactId]:
string
Contact ID
message[messageText]:
required
string
A custom message text

Examples


Result Format


Documentation

[block:callout] { "type": "warning", "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.", "title": "Target Audience - Single Contact Distributions" } [/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 }}