Skip to main content

CreateDistributionRequest

oneOf
message objectrequired

message libraryID

libraryIdLibraryId (string)

Library ID of the message

Example: UR_1M4aHozEkSxUfCl
messageIdMessageId (string)

The ID for the desired library message

Example: MS_0Vdgn7nLGSQBlYN
messageTextMessageText (string)

Text of the message to send

Example: Example Message Text
recipients objectrequired
mailingListIdMailingListId (string)

The mailing list or contact group associated with the distribution(s)

Example: CG_012345678901234
contactIdContactLookupId (string)

contact lookup ID for individual distribution (CGC_ or MLRP_ prefix)

Example: CGC_012345678901234
transactionBatchIdBatchId (string)

transaction batch, or set mailingListId

Example: BT_ZZZZ45678901234
directoryIdDirectoryId (string)

The ID for the directory, also known as a pool ID

Possible values: Value must match regular expression ^POOL_\w+$

Example: POOL_2t0pE8tJnEEmgD3
header objectrequired
fromEmailFromEmail (string)required

Email from address

Example: apiexample@qualtrics.com
replyToEmailReplyToEmail (string)

Email reply-to address

Example: apiexample@qualtrics.com
fromNameFromName (string)required

Email from name

Example: Test Name
subjectSubject (string)required

Email subject; text or message id (MS_)

Example: Example Subject
surveyLink objectrequired
surveyIdSurveyid (string)

The survey ID associated with the distributions

Example: SV_cHbKMOdeT8NetF3
expirationDatestring<date-time>

link expiry date

typeLinkType (string)

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.

property name*string
sendDatestring<date-time>required

date to send

CreateDistributionRequest
{
"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"
}