API Schedules
Our API docs can be found here: https://docs.redeye.com/api/
API Schedules
Our API driven schedules allow you to trigger email, SMS or push content via the use of our API. These schedules are set up in the same way as a standard email/SMS just without any recipients, as these are passed in the API call.
API schedules don't need a start timer
We have two types of API schedule that you can use:
Service API schedules
Service API schedules send instantly. They're used for fire & forget communications such as transactional messaging or customer updates.
Key Features:
- Instant delivery
- Fire & forget schedules
- Only data/merges passed within the API call can be used in the Creative/SMS.
- Unable to reference segments, custom rules, or apply external Dynamic Content
Service API schedules DO NOT touch the databaseThe reason service API schedules can send so quickly is that the data passed within the Service API call doesn't get stored in the database. The data is added to the email creative and sent to the customer.
We retain records that a customer has been sent a Service API schedule, but any data passed within the API call cannot be used in segmentation or referenced elsewhere in the platform.
Marketing API schedules
On the other hand, Marketing API schedules DO enter the database. These don't send quite as instantly as Service API schedules, but are still delivered within a few minutes.
Key Features:
- Delivered within a few minutes
- Data is processed and entered into the database
- Able to reference other data from the database
- Can use external Dynamic Content, boolean content, merge fields and customer data.
Use-cases for API Driven schedules
- Transactional Messages
- Order Updates
- Instant communications
- App-driven activity
Updated 10 months ago
