send

The send call is intended for sending triggered messages using a specified template to a specified user. You can also retrieve information on a sent or scheduled transactional.

For campaign (mass-message) sending, you should exclusively use the blast API instead, or the blast_repeat API for recurring campaigns. This will ensure proper deliverability and efficiency, and enable campaign-specific features. Note that triggered sends can also be sent as a result of Purchase API calls (for example, purchase receipts or abandoned cart reminders) or via triggers that are set in response to user actions on previous triggered sends. 

Endpoint URL: https://api.sailthru.com/send

GET Triggered Send

Retrieve all information about a specific triggered send.

Get by send_id

Example Call:

{
  "send_id" : "WBo2fryq0sw9qI93"}

Response

Example Response:

{   
  "status" : "delivered",
  "send_key" : null,
  "view_url" : "http://cb.sailthru.com/view/WBokwLyq0jgtqI94/2404d754",
  "text_url" : "http://cb.sailthru.com/textview/WBokwLyq0jgtqI94/8a8d8e60",
  "send_id" : "WBokwLyq0jgtqI94",
  "template" : "Confirmed Opt-In",
  "send_time" : "Wed, 02 Nov 2016 13:39:12 -0400",
  "email" : "user@example.com"}

Required Parameters

Response Parameters

POST to Send, Schedule or Update

Send a triggered email, schedule one for the near future, or update the parameters of a scheduled triggered email.

Basic Send

Example Call (with minimum parameters, email address and template):

{
  "template" : "Product Alert",
  "email" : "user@example.com"}

Example Response:

{
  "email" : "user@example.com",
  "send_id" : "WGrLf25K3Fwzi4ry",
  "template" : "Product Alert",
  "status" : "unknown",
  "send_key" : null
}

Advanced Send

Example Call:

{
  "template" : "Product Alert",
  "email" : "doug@example.com",
  "options":{"headers":{"Cc":"bob@example.com"}},
  "schedule_time" : "2017-01-01 00:00:00",
  "vars": {"FirstName":"Douglas","LastName":"Crockford"},
  "data_feed_url" : "https://feed.sailthru.com/ws/feed?id=908ec3891aa312f74f8b4573"}

Example Response:

{
  "email" : "user@example.com",
  "send_id" : "WGrLf25K3Fwzi4ry",
  "template" : "Product Alert",
  "status" : "scheduled",
  "schedule_time" : "Sun, 01 Jan 2017 00:00:00 -0500",
  "send_key" : null
}

SMS Send

Send a transactional SMS using the same POST method as you use for a transactional email send. If the profile related to the email address has an SMS number as a profile key, the message should send the same way as a regular transactional message. 

{
"template":"SMS_Test",
"email":"example@sailthru.com"}

Create an SMS template after there is an SMS number assigned to your client account. That way the from_sms field will pull in the SMS number properly.

Required Parameters

Optional Parameters

Response Parameters

Will be identical to the return value of GET mode. This includes the send_id which you can use to reference the message later. Because the email has just sent, the status of a send will always be unknown at the moment it has sent. This is expected behavior. If you do a GET call a little later, you can retrieve the delivery status.

Update Scheduled Send

By logging the send_id of a scheduled send, you can later update that send by submitting a new POST mode call using the send_id parameter. You can additionally submit email, vars, and template to update existing parameters. Parameters not resubmitted will remain as originally submitted.

Send to Multiple Recipients

You can send the same template to multiple email addresses at once (up to 5 per API call). If you are doing this on a large scale, you may want to consider sending it as a campaign instead, using the blast API.Use multiple, comma-separated email addresses as the email parameter value. You may also include the following parameter if you wish to include unique var values per recipient:

For example:

{
  "template" : "Example Template Name",
  "email" : "user1@example.com,user2@example.com,user3@example.com",
  "evars": {
    "user1@example.com": {
      "greeting" : "Hello", "signoff" : "Bye!"    },
    "user2@example.com": {
      "greeting" : "Bonjour", "signoff" : "Ciao"    },
    "user3@example.com": {
      "greeting" : "Greetings!", "signoff" : "Ta-ra!"    }
  }
}

The return value will be slightly different for a multi-send and will return:

["user1@sailthru.com" : "WFw4hukyi7E8i060",
"user2@sailthru.com" : "WFw4hukyi7E8i061",
"user3@sailthru.com" : "WFw4hukyi7E8i062"]

Combining schedule_time with a multi-user send is not supported.

A/B Test Sends

For templates that have A/B test versions, upon each send to the template, the system will pick randomly between the different A/B versions. After a period of time, you will be able to compare the results and determine which is the most effective template.

A user's placement in the A or B grouping will persist for all future triggered test sends.

DELETE a scheduled send

Delete Send

Example Call:

{
  "send_id" : "WGrLf25K3Fwzi4ry"}

Example Response:

{
  "send_id" : "WGrLf25K3Fwzi4ry"  "ok" : true,
  "send_key" : null
}

Cancels an email that you had previously scheduled for future sending with the schedule_time parameter. It is not possible to cancel an email that was sent immediately, without a future schedule.

Required Parameters

Response Parameters

Error Codes

GET

POST

DELETE