CreateSmsDistributionRequest
sendDatestring<date-time>required
Time to send the SMS. See Dates and Times for more information on the date and time format.
methodstringrequired
Determines how the survey will be sent out via SMS. Can be either Invite, Interactive, Reminder or Thankyou. Interactive means the questions are presented to the user one at a time in an interactive ping-pong type interactive-type session.
Possible values: [Invite, Interactive, Reminder, Thankyou]
surveyIdSurveyid (string)required
The survey ID associated with the distributions
Example:
SV_cHbKMOdeT8NetF3namestringrequired
Name for the SMS distribution.
recipients object
mailingListIdMailingListId (string)required
The mailing list or contact group associated with the distribution(s)
Example:
CG_012345678901234contactIdContactLookupId (string)
contact lookup ID for individual distribution (CGC_ or MLRP_ prefix)
Example:
CGC_012345678901234parentDistributionIdDistributionId (string)
The Distribution ID
Example:
EMD_1234567890abcdemessage object
libraryIdLibraryId (string)
Library ID of the message
Example:
UR_1M4aHozEkSxUfClmessageIdMessageId (string)
The ID for the desired library message
Example:
MS_0Vdgn7nLGSQBlYNmessageTextMessageText (string)
Text of the message to send
Example:
Example Message TextCreateSmsDistributionRequest
{
"sendDate": "2024-07-29T15:51:28.071Z",
"method": "Invite",
"surveyId": "SV_cHbKMOdeT8NetF3",
"name": "string",
"recipients": {
"mailingListId": "CG_012345678901234",
"contactId": "CGC_012345678901234"
},
"parentDistributionId": "EMD_1234567890abcde",
"message": {
"libraryId": "UR_1M4aHozEkSxUfCl",
"messageId": "MS_0Vdgn7nLGSQBlYN",
"messageText": "Example Message Text"
}
}