SendEmailToGroup/ sends a message to an existing Higher Logic Thrive Marketing Enterprise (Thrive Marketing Enterprise) group. Recipients of that group will only receive the message if:
- They are not suppressed
- They are not unsubscribed
- They have not already received the message
Example
Send a message to recipient groups:
{
"SessionID":"00000000-00000-0000-0000000000000",
"UserID":"SAMPLE",
"AdHocList":["recipient@higherlogic.com"],
"BillingCode":"test",
"BillingInitial":"zz",
"FaxResolution":"",
"FilteredGroups":[],
"From":"test@higherlogic.com",
"GroupIDs":[2981452],
"HTMLWVL":true,
"IgnoreDedupe":true,
"LoginID":62838,
"MessageID":12399806,
"RssType":0,
"ScheduledDate":"2017-03-10T20:30:00",
"SendDespiteArchived":true,
"SendDespiteBadFrom":true,
"SendFaxOrEmailOnFailure":true,
"SendType":"EmailOnly",
"Subject":"Message Subject",
"TXTWVL":true
}
HTTP POST
https://dna.magnetmail.net/ApiAdapter/Rest/SendEmailToGroup/
POST parameters
NOTE: This call does not have conditional parameters.
Required parameters
| Parameter | Value | Description |
|---|---|---|
| SessionID | String | This is an authentication token which can be obtained by making the authenticate call. |
| UserID | String | The UserID returned in the authenticate call. |
| LoginID | Int | The login ID of the individual sending the message. This is returned in the authenticate call. |
| AdHocList | String | Additional recipients who should receive the message (e.g., [“test@higherlogic.com,jdoe@higherlogic.com”]). |
| BillingCode | String | If this is set to Required for the account. For Client purposes only. Pass a string value up to 40 characters. |
| BillingInitial | String | If this is set to Required for the account. For Client purposes only. Pass a string value up to 3 characters. |
| FaxResolution | String | For email messages, this value is nullable “”; if completing a fax send, this value can be set to either Standard or Fine. |
| FilteredGroups | Int | Comma-separated list of group IDs that should be filtered out before the message sends. |
| From | String | This is the email address the message is from. Valid from address up to 100 characters. This can include the vanity portion and email address using proper syntax. |
| GroupIDs | Int | Comma-separated list of group IDs that the message should be sent to. |
| IgnoreDedupe | Boolean | If enabled for the account, this flag when set to True will ignore the messages that were sent to Individual during testing. If the recipient is in the group they will receive the message. |
| MessageID | Int | This is the ID of the message. Use the GetMessageList/ method to find the message by name and capture the message ID. Pass only a single value in this attribute. |
| RssType | Int |
NOTE: Set to 0. This is a deprecated variable. Historic accounts may still use this functionality and can rely on the types: noRSS, RSSOnly, RSStoSelectedGroups. |
| ScheduledDate | String | The date and time the message is scheduled to go out. This must be in an acceptable format (e.g., YYYY-MM-DDTHH:MM:SS). |
| SendDespiteArchived | Boolean | Send the message despite its archived status. If set to true, even if the message has been archived, it will send. |
| SendDespiteBadFrom | Boolean | Send the message regardless of whether the From Address is properly formatted. |
| SendFaxOrEmailOnFailure | Boolean | Send the fax version of a message to a bounced email address or send an email to a undeliverable fax. |
| SendType | String | If left “”, the send type will default to EmailOnly. Other values include EmailFaxPriorityEmail, EmailFaxPriorityFax, EmailOnly, FaxOnly faxToFailedEmail. |
| Subject | String | This is the Subject Line of the message (can be up to 100 characters). |
| HTMLWVLink | Boolean | Enables you to insert the HTML web version link; otherwise, set to True to give recipients the ability to see “Click here for the mobile version” at the top of the HTML version of the message. |
| TXTWVLink | Boolean | Enables you to insert the Text web version link. Otherwise, set to True to give recipients the ability to see “Click here for the mobile version” at the top of the text version of the message. |
Optional parameters
| Parameter | Value | Description |
|---|---|---|
|
JobNotification These variables are required if a Job Notification should be sent. If Notifications are required, use the REST call SendEmailToGroupWithProfile:
|
||
| CompleteNotification | Boolean | Whether or not to use notification when the message has completed sending. |
| CompleteNotificationFrom | String | The email address where the complete notification will be coming from. |
| CompleteNotificationTo | String | The email address of the recipient who will be receiving this notification message. |
| CompleteNotificationWhen | Int | The number of hours after a message is sent to send a tracking report. Values are 2,6,12,24,48,72. |
| SendNotificationFrom | String | The email address where the notification will be coming from. |
| SendNotificationTo | String | The email address of the recipient who will be receiving this notification message. |
| SendNotificationWhen | Int | Int Send notification now (pass a 0), or when message is scheduled (1). |
| ShouldSendNotification | Boolean | Whether or not to use the send notification on this message when a job starts. |
| MiscArguments | String | Any Misc Arguments. |
|
NewsLetter These variables are required if a message should be sent to the Message Library. |
||
| NewsLetterArchive | Boolean | Will this message be added to the Message Library. |
| NewsLetterPublishDate | dateTime | The date and time the message is scheduled to publish to the library, this must be in an acceptable format. Ex. YYYY-MM-DDTHH:MM:SS |
| NewsletterName | String | The name of the newsletter in the Library |