CreateDistributionRequest
oneOf- Option 1
- Option 2
- Option 3
message objectrequired
message libraryID
Library ID of the message
UR_1M4aHozEkSxUfClThe ID for the desired library message
MS_0Vdgn7nLGSQBlYNText of the message to send
Example Message Textrecipients objectrequired
The mailing list or contact group associated with the distribution(s)
CG_012345678901234contact lookup ID for individual distribution (CGC_ or MLRP_ prefix)
CGC_012345678901234transaction batch, or set mailingListId
BT_ZZZZ45678901234The ID for the directory, also known as a pool ID
Possible values: Value must match regular expression ^POOL_\w+$
POOL_2t0pE8tJnEEmgD3header objectrequired
Email from address
apiexample@qualtrics.comEmail reply-to address
apiexample@qualtrics.comEmail from name
Test NameEmail subject; text or message id (MS_)
Example SubjectsurveyLink objectrequired
The survey ID associated with the distributions
SV_cHbKMOdeT8NetF3link expiry date
Individual, Multiple, or Anonymous
Possible values: [Individual, Multiple, Anonymous]
embeddedData objectnullable
Contains up to 10 subkeys. Each of these subkeys has a name, consisting of no more than 200 characters, and a value, consisting of no more than 1024 characters.
date to send
{
"message": {
"libraryId": "UR_1M4aHozEkSxUfCl",
"messageId": "MS_0Vdgn7nLGSQBlYN",
"messageText": "Example Message Text"
},
"recipients": {
"mailingListId": "CG_012345678901234",
"contactId": "CGC_012345678901234",
"transactionBatchId": "BT_ZZZZ45678901234",
"directoryId": "POOL_2t0pE8tJnEEmgD3"
},
"header": {
"fromEmail": "apiexample@qualtrics.com",
"replyToEmail": "apiexample@qualtrics.com",
"fromName": "Test Name",
"subject": "Example Subject"
},
"surveyLink": {
"surveyId": "SV_cHbKMOdeT8NetF3",
"expirationDate": "2024-07-29T15:51:28.071Z",
"type": "Individual"
},
"embeddedData": {},
"sendDate": "2024-07-29T15:51:28.071Z"
}