API Overview

The Sailthru API allows you to interact programmatically with an array of Sailthru features and data sets. For example, add users, send campaigns, push and update content in realtime, and more.

The Sailthru API is a REST-based service. You can get a kickstart with our language-specific Client Libraries and reference our full API documentation below. Some common uses for our API:

  • Send individual email messages – For example, automated welcome emails, purchase confirmation emails, or other transactional messages. Use the Send and Template calls. See also: Transactional Emails.
  • Send email campaigns – Schedule delivery to multiple recipients. For example, a daily or weekly newsletter. Use a Blast call. See also: Campaigns, Lists.
  • Set user data or list subscriptions – Subscribe users to or unsubscribe users from your lists. Add or update data for any user. See the User call. See also: List Management.
  • Perform data processing tasks – For example, imports of subscriber lists, bulk user data updates, and exports of user data. Use the Job call to start a job or check its status.

API Endpoints

Click an endpoint name to view its reference documentation.

Email Delivery and Subscription Management

blast

Schedule or check the status of a Campaign or ‘mass mail blast’. See also: Campaigns

list

Create lists or update the subscription status of entire lists of users. See also: Creating Lists, Integrate Lists, Setting Variables

send

Send, check status or delete triggered transactional email. See also: Transactionals

template 

Create or edit templates for your triggered mail. See also: Template OverviewOptimize Templates

preview 

Preview blasts and templates

trigger 

Create / update / delete transactional trigger. See also: Sending Triggers for Transactionals

Reporting and User Data Management

job

Covers several actions including importing / updating / exporting subscribers, getting stats from sent email campaigns, and querying your subscriber analytics in aggregate

user

Add/change/merge identifying keys to user profiles and query by engagement

stats

Request summary stats about your subscribers, email campaigns, and transactional emails

Site Content (Horizon)

content

Add or update content to Horizon, triggering any matching alerts for users. See also: Horizon in Templates

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

E-commerce Data

purchase

Various aspects of e-commerce from recording an e-commerce shopping cart or checkout event to tracking abandoned shopping carts

Advertising

ad/plan

Update or get information on an Ad Targeter plan

Settings

settings

Display and change your settings

Test Interface

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

Technical Information

Postbacks

Receive exception/error alerts and update information on your servers in response to user actions like opt-outs and hardbounces using API Postbacks.

Top