Sailthru API

The purpose of the sailthru API is to allow you to take full advantage of all the features of your Sailthru service as efficiently as possible.

• Step 1 - Download one of our pre-built libraries for your chosen programming language - review the list at client libraries.
• Step 2 - Install and configure your chosen pre-built library - for details see "Getting Started".
• Step 3 - Write code inside your application to directly perform the desired Sailthru action. For example, this can often be as little as one line of code.

With this automation in place, you and your colleagues will spend less time in the Sailthru web interface and the experience you will provide your users will be more seamless.

The Sailthru API is a simple REST-based service. Here are some of the typical use cases for API usage:

• When chosen events occur in your application, for example, a user signup
• Overview : "Transactional Email" / API Details : "Send Command reference"

• To schedule delivery to multiple recipients, for example, a newsletter
• Overview : "Campaigns or 'mass mail blasts'" / API Details : "Blast Command reference" / Examples

• Subscribe and unsubscribe email address to your email lists, for example, a 'site updates' list
• Overview : "Lists" / API Details : "Email Command reference" / Examples

• Start a Job, or get the status of a background Job ; Examples include:
  • subscriber list imports / Details
  • bulk updates of subscriber information / Details
  • exports of subscriber information / Details
  • get the status of an in-progress job / Details

The API has several calls across several different functional areas. Here is a quick explanation of the various API features.

Each item corresponds to a separate API call type - you should refer to the specifics for each client implementation for the exact method/function names needed to use each call.

• email - to access and update the subscription status of individual email addresses / subscribers
• send - to send, check status or delete triggered transactional email (Transactional Overview)
• blast - to schedule or check the status of a Campaign or 'mass mail blast' (Campaigns Overview)
• template - create or edit templates for your triggered mail (Template info)
• list - create or update entire lists of subscribers (Lists Overview)

• stats - request summary stats about your subscribers, your email blasts and your transactional emails
• job - "Job" covers several actions including importing / updating / exporting subscribers, getting stats from sent email blasts and querying your subscribers analytics in aggregate

• horizon - reads and writes the Horizon cookie to enable Horizon functionality for a subscriber (Horizon Overview)
• purchase - record an ecommerce shopping cart or checkout event, for "abandoned-shopping-cart emails"
• content - add or update a piece content to Horizon, triggering any matching alerts for users (see below)

• alert - update or retrieve a user's alert settings - alerts are special transactional emails that notify your users of content on your site that matches certain custom criteria (Alerts Overview)
• trigger - create / update / delete transactional trigger (beta)
• inbox - setup inbox for incoming emails (beta)
• preview - preview blasts and templates (beta)
• settings - display and change your settings (beta)

You can also test API calls directly using the API test form.

Note, you must be logged into Sailthru's web interface to use the API test. Users in our new interface should use http://my.sailthru.com/api/test.

• Postbacks - Postbacks are used to keep the information on your web application current in response to user actions like opt-outs and verifications.
• API Technical Details - If you are interested in writing your own client, or coding directly to the API
• Error Codes - a complete list of the error codes you can receive from the API
• HTTP Response Codes and Errors

• Tutorials and examples