For Developers Overview

This section is a guide to the API and to Zephyr, a template and coding language.

These aspects of your setup and integration with other systems are best accomplished with the help of a developer. Speak with your Customer Success representative or Support if you need guidance or have any questions.

Contents

• API
  Work with data, such as user, content, and commerce data. Initiate actions, including transactional email sends and events that trigger email.
  • Introduction & Endpoint Reference
  • Client Libraries
  • JS API Integration Functions
• Zephyr
  A template coding language that allows you to bring advanced logic and personalized data into your email and web content.
  • Overview
  • Function Reference

Where to Start?

Here are some common ways that you may want to use the API and Zephyr.

• Content
  Sync your content or products for intelligent display in email or on site. Ensure that your site’s content–typically article or product metadata–is synchronized using your chosen combination of the JavaScript tag on your site, Content API calls, or Job API bulk-updates. Then, to use this content in your templates, produce customized data feeds from your Content Library or use a personalize() function that pulls straight from the Content Library without a feed.
• Templates
  Combine HTML and CSS with Zephyr code to create dynamic individually personalized emails. Code templates with a sophisticated template language Zephyr in conjunction with your HTML and CSS code. Zephyr lets you personalize emails and websites with dynamic content and customize your templates with a host of other functions: automatically produce social media share links, user management page links, and more.
• Sends
  Configure other systems to send email with the platform. Using the Send API, generate transactional messages–on-demand messages sent to individual users. (Note that these can also be configured with the visual web interface of Lifecycle Optimizer.) You can also configure pairs of events and triggers to determine when transactionals should be sent, or what should happen as the result of transactional sends or actions on those sends, like users’ link clicks or purchases. Using the Blast API, configure Campaigns – bulk messages sent to group of users based on a list and template, which you may configure as recurring.
• User Management and Data
  Store data in user profiles, central to your personalization efforts. Maintain robust user profiles that can be used to segment users, personalize content and more. Store custom data on user profiles in the form of user vars. You can update and access user data stored in the platform at any time with the User or Job API, or add users directly from a browser form with additional JavaScript functions on your site. Using the List API, access and update list membership and create dynamic Smart Lists of users who match particular attributes.
• Purchases
  Sync your customer cart status and completed purchases using the Purchase API or JavaScript functions.
• Analytics Use the
  Stats API and Job API to pull detailed reports and information on lists, campaigns, and transactional sends.
• More
  Browse our many additional API endpoints, allowing you to interact with many features, and our Client Libraries–prewritten code libraries in 7 different languages for engaging with the APIs.