SendEmailToGroupWithProfile/ sends a message to an existing Higher Logic Thrive Marketing Enterprise (Thrive Marketing Enterprise) group when Sending Profile is enabled. 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 when Sending Profile is enabled:
{
"SessionID":"00000000-00000-0000-0000000000000",
"UserID":"SAMPLE",
"FaxResolution":"",
"GroupIDs":[1234567],
"IncludeRecipientsThatAlreadyReceivedTheMessage":true,
"LinkTrackingOptions": {
"EnableHTMLVersion":true,
"EnableMessageOpens":true,
"EnableTextVersion":true },
"LoginID":12345,
"MessageFromAddress":"\"John Doe\"<test@higherlogic.com>",
"MessageID":1234567,
"MessageSubject":"Message Subject",
"ReplyToEmailAddress":"test@higherlogic.com",
"Resend":true,
"ScheduledTime":"2017-03-10T20:30:00",
"SendMessageDespiteBadFromAddress":true,
"SendType":"emailonly",
"SenderProfileName":"Profile Name",
"UseHTMLWebVersionLink":true,
"UseTextWebVersionLink":true }
}
HTTP POST
https://dna.magnetmail.net/ApiAdapter/Rest/SendEmailToGroupWithProfile/
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. |
| FaxResolution | String | For email messages, this value is nullable ""; if completing a fax send, this value can be set to either Standard or Fine. |
| GroupIDs | Int | Comma-separated list of group IDs that the message should be sent to. |
| IncludeRecipientsThatAlreadyReceivedTheMessage | 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. |
| LinkTrackingOptions The remaining parameters detail whether tracking should be enabled for the message. |
||
| EnableHTMLVersion | Boolean | Whether links clicked in the HTML version of the message should be tracked (we recommend setting this to True). |
| EnableMessageOpens | Boolean | Whether opens should be tracked for the message (we recommend setting this to True). |
| EnableTextVersion | Boolean | Whether links clicked in the Text version of the message should be tracked. If set to true, links in the text-only version will be formatted to match Thrive Marketing Enterprise’s tracking code appended. |
| MessageFromAddress | String | This is the email address the message is from. Valid from address up to 50 characters. This can include the vanity portion and email address using proper syntax. |
| 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. |
| MessageSubject | String | This is the Subject Line of the message (it can be up to 100 characters). |
| ReplyToEmailAddress | String | The name of the newsletter in the Library. |
| ReplyToAddress | String | Pass a valid email address if a different address is needed as the reply-to for the message instead of the from address. Proper syntax is required. Both vanity and email address portion are accepted. |
| Resend | Boolean | Send the fax version of a message to a bounced email address or send an email to a undeliverable fax. |
| ScheduledTime | 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). |
| SendMessageDespiteBadFromAddress | Boolean | Send the message regardless of whether the From Address is properly formatted. |
| SendType | String | If left "", the send type will default to EmailOnly. Other values include EmailFaxPriorityEmail, EmailFaxPriorityFax, EmailOnly, FaxOnly, faxToFailedEmail. |
| SenderProfileName | String | If Sending Profile is enabled for the account, which profile should the message send from. This field should be used if a specific sending profile should be used. Otherwise, the default sending profile will be used. This is configured through the Thrive Marketing Enterprise interface and includes IP address, sending domain, and other sending profile items. |
| UseHTMLWebVersionLink | 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. |
| UseTextWebVersionLink | 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
These parameters are optional, and are not required under any condition.
| Parameter | Value | Description |
|---|---|---|
| AdditionalRecipients | String | Additional recipients that 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. |
| FilteredGroupsIDs | Int | Comma-separated list of group IDs that should be filtered out before the message sends. |
| JobIPID | Int | If Sending Profile is enabled for the account, which IP address should the message send from. For all other jobs, this will be 0. SendProfileName will overwrite this setting if it is selected. |
|
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 |
|
Notification 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. |
| 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. |
| Tag1 | String | This Source Code 1 for the message send. Pass a string value up to 25 characters. |
| Tag2 | String | This Source Code 2 for the message send. Pass a string value up to 25 characters. |