Create An API Triggered AMR

API Triggered automated message rules send messages when a rule is called via the API.

About this task

This type of message allows for easy management and reporting for emails sent by an in-house or third party system which has been integrated with the application. You can use the id assigned to a given automated message rule to reference it. To obtain an id for a given Automate Message Rule, call the readMessageRules function.

To create an API Triggered AMR:

Procedure

  1. Go to Automation > Automated Message Rules.
  2. Click Create New Automate Message Rule.
  3. Enter a name for the rule in the Name: box.
  4. Select API Triggered from the Select a type list.
  5. Click Next Step.
  6. Set the sending options from the API Options choices:
    • Choose Allow API to select sending options to set the sending options using the API.

      If you choose to have the API select the sending options, you will need to fill out the Sender Options and Automated Message Rule Content sections either manually or via the API.

    • Specify sending options to set the sending options in the Sender Options section.
  7. If you selected Specify sending options enter the relevant information for the Sender Options.
    • From Name: The from name, also called an alias, is the name that appears to the recipient of the message.

      The From Name, From Email Address, and Reply-To Address text boxes support the use of field tags, special tags, and content tags. For more information on these tags see either Message Tags or Content Tags.

    • From Address: The from address is the email address that your message will appear from.
    • Reply Address: The reply address is the address that the application will forward email replies to.
      Note: Reply Tracking also requires that the domain in the From line be the same as the domain of the originating email server. We also automatically add Sender Authentication when Reply Tracking is enabled. Because the application is sending your message, your From address changes to an address from our domain. Your site name is also included in the From address. You may change the email address where we will forward all email replies to.
    • Enable Sender Authentication: Checking the Enable Sender Authentication box will sign your message with DomainKeys/DKIM (an authentication method that can optimize your message delivery to Hotmail, MSN, and Yahoo! email addresses).
    • Enable Reply Tracking: Enabling Reply Tracking will store a copy of all email replies to your email messages on the Email Replies page. You may find this option convenient if you need someone other than the email address in the From line to read email replies, or if you simply want us the application to store email replies.
      Tip: For more information on email replies in the application, see Email Replies.
    Warning: Bad From Email addresses will be treated as a soft-bounces and you will still be charged for an email. It is up to you to make sure that if you are using special tags, field tags, or content tags in the from address, that they are replaced with valid email addresses. For more information on bounces, see Email Bounce.
  8. Pick the message that will be sent via the automated message rule.
    1. Click Pick Message.
    2. From the window that appears, search for the message you want to use.
    3. Click on the name of the message you want to use.
    4. Click Select.
  9. Click
    • Optional: Advanced to set an expiration, delivery rate, and additional contact filtering options.
    • Verify Settings to review your automated message rule.

      If you click Verify Settings, skip to the last step.

  10. If you clicked Advanced: Set the Expiration options.
    • Click Continues forever if you want the AMR to continue indefinitely.
    • If you want the AMR to end, click Deactivate after, enter a number in the box, and select days, weeks, months, or years.

      The days begin counting when an automated message rule is activated, and are reset to 0 if the rule is deactivated and then reactivated. An automated message rule can also be manually deactivated at any time from the overview page for an individual automated message rule.

  11. If you clicked Advanced: Select a Delivery Rate from the Send Message list.

    Many major ISPs track a sender's reputation based on the number of unsolicited email complaints that they generate over a certain period of time. Spreading your delivery over time can help mitigate the impact of this issue, help ensure optimal deliverability, and mitigate traffic spikes on your website. For example, 20 unsolicited email complaints received over 8 hours, though certainly undesirable, will be a softer blow to your sender rating than the same 20 complaints received over 15 minutes.

  12. If you clicked Advanced: Set the Additional Contact Filtering criteria.
    • To make members of a list or segment exempt from receiving emails from an automated message rule, click the Ineligible Recipients tab. Then click either Lists or Segments tab and select the list or segment you want to be exempt.
    • To limit to automated message rule to only contacts on a specified list or segment, click Eligible Recipients tab. Then click Only contacts on Lists or Segments selected below are eligible to receive messages from this automated message rule, click either the Lists or Segments tab, and select the list or segment you want to limit the rule to.
  13. Click Verify Settings.
  14. Review the options you have set for your AMR and click
    • Go Back to return any of the previous steps.
    • Save As Draft to save but not activate the AMR.

      You can always activate your AMR from the main Automated Message Rule page. For more information see Activate Or Deactivate AMRs.

    • Save Activate to save all of the options you have selected and activate the automated message rule.

      Activating your automated message rule means that it will immediately begin sending messages based on the options you choose in the automated message rule wizard. When you deactivate an automated message rule, messages will no longer be sent using that automated message rule. Deactivating an automated message rule does not delete the automated message rule, allowing you to reactivate the automated message rule later on. If you want to delete an automated message rule, click Delete This Automated Message Rule.