SendRoll API Overview¶
SendRoll is AdRoll’s email advertising solution. Triggered by browsing behavior, SendRoll emails help win customers with personalized product recommendations, promotions, or cart reminders.
Find out more about SendRoll.
Authentication and authorization are done using AdRoll’s authentication service. Only HTTPS is supported. Authentication is performed by either Basic Auth. This ensures that access to any object (e.g. advertisable, campaign, email, etc.) can occur only if the currently logged-in user has permission to do so.
All endpoints are invoked with
The objects of AdRoll model form a likely familiar (e.g., AdWords-esque) hierarchy.
- Advertisable - an advertising profile representing a brand (e.g., “Bob’s Pets”)
Campaign 1 – SendRoll Campaigns configure the goals and user behaviour that will trigger –or cancel– an email to them.
- Campaign N
- CampaignEmail 1 – Defines the content of the email as a template and when it will be sent to a user. Several emails can be chained one after another to drive a reaction from the user. Once a reaction is detected the chain is stopped.
- CampaignEmail ...
- CampaingEmail N
- Segment 1 – Segments represent conditions that will trigger or cancel an email to a user. A segment can be used either for inclusion or exclusion; triggering or cancelling an email send. Segments can be AdRoll’s own segments, lists of Emails provided the customer, etc.
- Segment ...
- Segment N
Each object is referred to with a unique id (called an “EID” or external id) which consists of 22 alphanumeric characters (e.g., “AX4BDADOHNFIDLETVWBLY3”).