Skip to main content

Distribution

idDistributionId (string)

The Distribution ID

Example: EMD_1234567890abcde
parentDistributionIdDistributionId (string)

The Distribution ID

Example: EMD_1234567890abcde
ownerIdOwnerId (string)

The owner of a distribution

Example: UR_1M4aHozEkSxUfCl
organizationIdOrganizationId (string)
Example: exampleorganization1
requestStatusstring
requestTypeRequestType (string)

Possible values: [Invite, ThankYou, Reminder, Email, Portal, PortalInvite, GeneratedInvite]

sendDatestring<date-time>
createdDatestring<date-time>
modifiedDatestring<date-time>
headers object
fromEmailFromEmail (string)

Email from address

Example: apiexample@qualtrics.com
replyToEmailReplyToEmail (string)

Email reply-to address

Example: apiexample@qualtrics.com
fromNameFromName (string)

Email from name

Example: Test Name
subjectSubject (string)

Email subject; text or message id (MS_)

Example: Example Subject
recipients object
mailingListIdMailingListId (string)

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

Example: CG_012345678901234
contactIdContactLookupId (string)

contactLookupId or transactionId (CTR_)

Example: CGC_012345678901234
libraryIdLibraryId (string)

Library ID of the message

Example: UR_1M4aHozEkSxUfCl
sampleIdSampleId (string)

The ID for the desired sample

Example: CG_012345678901235
message object
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
messageTypeMessageType (string)

The type of the message. For Library the message text can be found using the Get Library Message endpoint. For Inline the message text is part of the Get Distribution response.

Possible values: [Library, Inline]

surveyLink object
surveyIdSurveyid (string)

The survey ID associated with the distributions

Example: SV_cHbKMOdeT8NetF3
expirationDatestring<date-time>
linkTypeLinkType (string)

Individual, Multiple, or Anonymous

Possible values: [Individual, Multiple, Anonymous]

stats object
sentinteger<int32>

Possible values: >= 0

Default value: 0
failedinteger<int32>

Possible values: >= 0

Default value: 0
startedinteger<int32>

Possible values: >= 0

Default value: 0
bouncedinteger<int32>

Possible values: >= 0

Default value: 0
openedinteger<int32>

Possible values: >= 0

Default value: 0
skippedinteger<int32>

Possible values: >= 0

Default value: 0
finishedinteger<int32>

Possible values: >= 0

Default value: 0
complaintsinteger<int32>

Possible values: >= 0

Default value: 0
blockedinteger<int32>

Possible values: >= 0

Default value: 0
embeddedDataobject

If multiple distributions for the survey are present, you will receive this object with a null value.

Distribution
{
"id": "EMD_1234567890abcde",
"parentDistributionId": "EMD_1234567890abcde",
"ownerId": "UR_1M4aHozEkSxUfCl",
"organizationId": "exampleorganization1",
"requestStatus": "string",
"requestType": "Invite",
"sendDate": "2024-07-29T15:51:28.071Z",
"createdDate": "2024-07-29T15:51:28.071Z",
"modifiedDate": "2024-07-29T15:51:28.071Z",
"headers": {
"fromEmail": "apiexample@qualtrics.com",
"replyToEmail": "apiexample@qualtrics.com",
"fromName": "Test Name",
"subject": "Example Subject"
},
"recipients": {
"mailingListId": "CG_012345678901234",
"contactId": "CGC_012345678901234",
"libraryId": "UR_1M4aHozEkSxUfCl",
"sampleId": "CG_012345678901235"
},
"message": {
"libraryId": "UR_1M4aHozEkSxUfCl",
"messageId": "MS_0Vdgn7nLGSQBlYN",
"messageText": "Example Message Text",
"messageType": "Library"
},
"surveyLink": {
"surveyId": "SV_cHbKMOdeT8NetF3",
"expirationDate": "2024-07-29T15:51:28.071Z",
"linkType": "Individual"
},
"stats": {
"sent": 0,
"failed": 0,
"started": 0,
"bounced": 0,
"opened": 0,
"skipped": 0,
"finished": 0,
"complaints": 0,
"blocked": 0
},
"embeddedData": {}
}