SendEmailToIndividual/ sends a message to an individual recipient that is not suppressed. See Modify a Recipient's Suppression Status for more information about modifying a recipient's suppression status.
NOTE: A recipient that has unsubscribed can still be sent an individual message.
Example
Send a message to recipient groups when Sending Profile is enabled:
{
"SessionID":"00000000-00000-0000-0000000000000",
"UserID":"SAMPLE",
"MessageID":12345,
"HTMLWVLink":true,
"TXTWVLink":true,
"Subject":"Subjectline World",
"From":"fromaddress@higherlogic.com",
"BillingCode":"123",
"BillingInitial":"123",
"Recipients":["test@higherlogic.com"],
"Identifier":"email",
"SendProfileName":null,
"ReplyToAddress":null
}
HTTP POST
https://dna.magnetmail.net/ApiAdapter/Rest/SendEmailToIndividual/
POST Parameters
NOTE: This call does not have optional 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. |
| From | 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. |
| Subject | String | This is the Subject Line of the message (can be up to 100 characters). |
| Recipients | Array | Email addresses the message will be sent to. If multiple email addresses, list them in a comma-separated format (e.g., [“test@higherlogic.com,jdoe@higherlogic.com”]). |
| 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. |
| Identifier | String | This is the Unique Identifier for the account. It will either be email or customID. |
| 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
These parameters are not required under any condition.
| Parameter | Value | Description |
|---|---|---|
| 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. |
| 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. |
| SendProfileName | 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 Higher Logic Thrive Marketing Enterprise (Thrive Marketing Enterprise) interface and includes IP address, sending domain and other sending profile items. |
| 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. |