alert

Overview

Retrieve, update, or delete a user's alert settings.

See also Alerts Overview.

Base URL

https://api.sailthru.com/alert

GET Mode

Retrieve a user's alert settings.

 

Required Parameters
Parameter Description Example
email The email address of the user to look up user@example.com
Return Value

A data structure consisting of email, realtime, and summaryproperties. emailwill be the user's email address, while realtimecontains a list of realtime alerts and summarycontains a list of summary alerts. Each individual alert is represented by a data structure including the following properties:

Property Description Example
alert_id A unique identifier for the alert 4c35637c7f8b9ae91c010000
type The type of the alert, either realtime, daily, or weekly daily
template The name of the email template alert_realtime
when The time of day (for summary alerts only) 11am

And possibly any of the following filtering properties:

Property Description Example
match Variables to exact-match against match[type]=shoes
min Minimum-value variables min[price]=30000
max Maximum-value match max[price]=50000
tags Tag-match tags[]=blue

 

 

POST Mode

Add a new alert to a user. You can add either a realtime or a summary alert (daily/weekly).

Required Parameters
Parameter Description Example
email The email address of the user user@example.com
type Either realtime, daily, or weekly
template The name of the email template alert_realtime
when (Required for summary alerts only) The time (to the nearest hour) to send the summary alert Friday 3pm
Optional parameters

Build the alert query. All properties are additive (AND).

Parameter Description Example
match Exact-match a custom variable match[type]=shoes
min Minimum-value variables min[price]=30000
max Maximum-value match max[price]=50000
tags Tag-match tags[]=blue

 

 

DELETE Mode

Remove an alert from a user's settings.

Required Parameters
Parameter Description Example
email The email address of the user to look up user@example.com
alert_id The unique identifier of the alert 4c35637c7f8b9ae91c010000