API Overview

The Sailthru API allows you to efficiently take advantage of all the features Sailthru offers.

1

Download

Download one of our pre-built libraries for your chosen programming language.
Review the list: Client Libraries

2

Install

Install and configure your chosen pre-built library.
See: Set Up Config File

3

Write Code

Write code inside your application to directly perform the desired Sailthru action.

 

With automation in place, less time is spent in the Sailthru interface and the experience you provide your users will be even more seamless.

 

Usage examples – what do customers do with the API?

The Sailthru API is a simple REST-based service. Here are some typical uses:

Send email messages to individuals

  • Send a single email to an individual. Examples include a welcome email or purchase confirmation, or other transactional emails.
  • API Details: Template call / Send call

Send email campaigns

  • Schedule delivery of an email to multiple recipients. For example, a newsletter. See campaigns.
  • API Details : Blast call

Add and update user subscriptions

Perform background processing tasks

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

 

Terminology and API Calls

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

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

Email delivery and subscription management

Reporting

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

Horizon – for logging site content and user interests to power personalization of email and websites

Site Personalization Manager

  • section – create or update sections of your website for site personalization
  • block – store templates (including Zephyr code and HTML) to configure section display

Advanced and beta API functionalities

  • purchase – various aspects of e-commerce from recording an e-commerce shopping cart or checkout event to  tracking abandoned shopping carts
  • ad/plan – update or get information on an AdFlight plan
  • preview – preview blasts and templates
  • API Postbacks – Get exception/error alerts and update the information on your servers in response to user actions like opt-outs and hardbounces
  • settings – display and change your settings
  • trigger – create / update / delete transactional trigger (Sending Triggers for Transactionals)

API Test Interface

You can also test API calls in the My Sailthru web interface using the API Test page. Note that you must be logged in to use this feature.

Other API Topics

Top