Skip to main content
The Sequences API is currently in public beta and may change based on feedback. Whenever possible, we will maintain backward compatibility and provide advance notice of any breaking changes.

​
Overview

A sequence is an automated series of steps — emails, tasks, and conditions — that runs against a person. Enrolling a person in a sequence creates an enrollment, which tracks that person’s progress through the sequence’s steps along with reply, bounce, and opt-out state. The Sequences API lets you manage these resources programmatically. The following API groups are available:
  • Sequence APIs let you list and retrieve sequences, inspect their steps, and pause or resume them
  • Enrollment APIs let you enroll people in sequences and query or manage enrollments and enrollment steps

​
Usage

​
Request format

The base URL of all API requests to the Sequences API is:
All APIs are built on REST principles and use standard HTTP methods to perform operations.

​
Authentication

API keys are used to authenticate requests to the Sequences API. You can generate an API key in Unify by navigating to Settings → Developers. To authenticate a request, include the following header in your request:
Replace <token> with your Unify API key.

​
Pagination

List endpoints are cursor-paginated. Each response includes a next_cursor value; pass it as the cursor query parameter to fetch the next page. A null next_cursor means there are no more results.

​
Rate limits

The Sequences API is rate-limited to 100,000 requests per five minute window. We may introduce daily limits in the future to prevent extraordinary usage.

​
OpenAPI specification

The OpenAPI specification can be found here.