ListDistributionsResponse
result objectrequired
Response information.
elements object[]required
The Distribution ID
EMD_1234567890abcdeThe Distribution ID
EMD_1234567890abcdeThe owner of a distribution
UR_1M4aHozEkSxUfClexampleorganization1Possible values: [Invite, ThankYou, Reminder, Email, Portal, PortalInvite, GeneratedInvite]
headers object
Email from address
apiexample@qualtrics.comEmail reply-to address
apiexample@qualtrics.comEmail from name
Test NameEmail subject; text or message id (MS_)
Example Subjectrecipients object
The mailing list or contact group associated with the distribution(s)
CG_012345678901234contactLookupId or transactionId (CTR_)
CGC_012345678901234Library ID of the message
UR_1M4aHozEkSxUfClThe ID for the desired sample
CG_012345678901235message object
Library ID of the message
UR_1M4aHozEkSxUfClThe ID for the desired library message
MS_0Vdgn7nLGSQBlYNText of the message to send
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
The survey ID associated with the distributions
SV_cHbKMOdeT8NetF3Individual, Multiple, or Anonymous
Possible values: [Individual, Multiple, Anonymous]
stats object
Possible values: >= 0
0Possible values: >= 0
0Possible values: >= 0
0Possible values: >= 0
0Possible values: >= 0
0Possible values: >= 0
0Possible values: >= 0
0Possible values: >= 0
0Possible values: >= 0
0If multiple distributions for the survey are present, you will receive this object with a null value.
Page number of result if response is divided across several pages. For the last page of results, the value returned is a URL.
meta objectrequired
Response metadata
HTTP status code.
Unique identifier of the associated request.
An informational string about the request.
{
"result": {
"elements": [
{
"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",
"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
}
}
],
"nextPage": "string"
},
"meta": {
"httpStatus": "string",
"requestId": "string",
"notice": "string"
}
}