How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Unify

Unify Sequence Enrollments API

Enroll people in sequences and pause, resume, cancel, list and bulk-export those enrollments. 11 operation(s).

Documentation Provider Profile APIs.io OpenAPI GitHub

Unify Sequence Enrollments API is one of 11 APIs that Unify publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Sequence Enrollments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, rate-limit docs, and authentication docs.

This API exposes 11 operations across 8 paths, and defines 50 schemas. It is described by OpenAPI 3.0.0, at version 1.

Requests are made against a single base URL, https://api.unifygtm.com.

11 operations 8 paths 50 schemas 1 DELETE5 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1
Base URL
https://api.unifygtm.com/sequences/v1
Authentication
API Key
Contact
Unify Support
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Unify Sequence Enrollments API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 11

Across 8 paths, the API surfaces 11 operations — 1 DELETE, 5 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Sequence Enrollments 11
POST
/sequences/v1/enrollments
Enroll a person in a sequence. mailboxemails lists candidate sending mailboxes, one of which is selected at enrollment time. If the person is already actively enrolled in a sequence, the request fail…
create_sequence_enrollment body → 201400401404409429500
GET
/sequences/v1/enrollments
List sequence enrollments — each tracks one person's progress through a sequence along with reply, bounce, opt-out, and pause state. Pages at most 100 enrollments per request; to export more than a f…
list_sequence_enrollments 9 params → 200400401429500
POST
/sequences/v1/enrollments/query-jobs
Start an asynchronous query job that exports sequence enrollments matching the optional filter; omitting filter exports all enrollments. Poll the job until it is FINISHED, then page through the resul…
create_sequence_enrollment_query_job body → 201400401429500
GET
/sequences/v1/enrollments/query-jobs
List sequence enrollment query jobs, optionally filtered by status.
list_sequence_enrollment_query_jobs 3 params → 200400401429500
GET
/sequences/v1/enrollments/query-jobs/{job_id}
Get a query job's status. Poll until the status is terminal; results are available once the job is FINISHED. Jobs expire 24 hours after creation.
get_sequence_enrollment_query_job 1 param → 200400401404429500
POST
/sequences/v1/enrollments/query-jobs/{job_id}/cancel
Cancel a query job. Only INPROGRESS jobs can be canceled.
cancel_sequence_enrollment_query_job 1 param → 200400401404409429500
GET
/sequences/v1/enrollments/query-jobs/{job_id}/results
Get Bulk API job results. By default this returns JSON. Send Accept: application/x-ndjson to stream newline-delimited JSON.
get_sequence_enrollment_query_job_results 3 params → 200400401404409410413429
GET
/sequences/v1/enrollments/{id}
Get a single enrollment by its ID.
get_sequence_enrollment 1 param → 200400401404429500
DELETE
/sequences/v1/enrollments/{id}
Cancel an enrollment, stopping any remaining steps for the person.
delete_sequence_enrollment 1 param → 200400401404429500
POST
/sequences/v1/enrollments/{id}/pause
Pause an enrollment, halting the person's progress through the sequence until it is resumed.
pause_sequence_enrollment 1 param → 200400401404429500
POST
/sequences/v1/enrollments/{id}/resume
Resume a paused enrollment so the person continues through the sequence.
resume_sequence_enrollment 1 param → 200400401404429500

Schemas 50

The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are Enrollment (18 properties), SequenceEnrollment (17 properties), BulkApiCommonQueryFilter (14 properties), BulkApiJob (7 properties). Each schema is shown below with its type and property counts.

BulkApiCommonQueryFilter
object
Filters shared by sequence enrollment and enrollment step Bulk API query jobs.
14 properties
BulkApiDatetimeRangeFilter
object
Datetime range filter. At least one bound must be provided. gt is mutually exclusive with gte, and lt is mutually exclusive with lte.
4 properties
BulkApiJob
object
Bulk API job representation.
7 properties 7 required
BulkApiJobStatus
string
Status of an asynchronous Bulk API job.
BulkApiMailboxEmailAddressFilter
object
Filter matching a mailbox by email address.
2 properties 1 required
BulkApiMailboxIdFilter
object
Filter matching a mailbox by ID.
2 properties 1 required
BulkApiUuidFilter
object
Filter matching a resource by ID.
1 property 1 required
CancelBulkApiJobNotCancelableResponse
object
Response returned when a Bulk API job is not cancelable.
CancelBulkApiJobSuccessResponse
object
Response returned when canceling a Bulk API job.
2 properties 2 required
CreateBulkApiJobSuccessResponse
object
Response returned when creating a Bulk API query job.
3 properties 3 required
CreateBulkApiSequenceEnrollmentsJobFilter
object
Filters accepted when querying sequence enrollments.
2 properties
CreateBulkApiSequenceEnrollmentsJobRequest
object
Request body for creating a sequence enrollments Bulk API query job.
1 property
CreateEnrollmentConflictResponse
object
Response returned when the person is already enrolled in an active sequence.
2 properties 2 required
CreateEnrollmentRequest
object
Request body for enrolling a person in a sequence.
3 properties 3 required
CreateEnrollmentSuccessResponse
object
Response returned when an enrollment is created.
DeleteEnrollmentSuccessResponse
object
Response returned when deleting an enrollment.
2 properties 2 required
Enrollment
object
A sequence enrollment.
18 properties 18 required
EnrollmentMailbox
object
Mailbox details embedded in enrollment responses.
5 properties 5 required
EnrollmentNotFoundResponse
object
Response returned when an enrollment cannot be found.
EnrollmentPerson
object
Person details embedded in enrollment responses.
5 properties 5 required
EnrollmentPlay
object
Details of the play that created an enrollment.
2 properties 2 required
EnrollmentReplyEmailMessage
object
Reply email message details embedded in enrollment responses.
1 property 1 required
EnrollmentSequence
object
Sequence details embedded in enrollment responses.
3 properties 3 required
GetBulkApiJobNotFoundResponse
object
Response returned when a Bulk API job cannot be found.
GetBulkApiJobResultsCanceledResponse
object
Response returned when a Bulk API job was canceled and has no results.
GetBulkApiJobResultsExpiredResponse
object
Response returned when Bulk API job results have expired.
2 properties 2 required
GetBulkApiJobResultsFailedResponse
object
Response returned when a Bulk API job failed and has no results.
GetBulkApiJobResultsNotReadyResponse
object
Response returned when Bulk API job results are not ready yet.
GetBulkApiJobResultsPayloadTooLargeResponse
object
Response returned when a requested Bulk API results page is too large.
2 properties 2 required
GetBulkApiJobSuccessResponse
object
Response returned when fetching a Bulk API job.
GetEnrollmentResponse
object
Response returned when fetching an enrollment.
ListBulkApiJobsSuccessResponse
object
Response returned when listing Bulk API jobs.
2 properties 2 required
ListEnrollmentsResponse
object
Response returned when listing enrollments.
2 properties 2 required
PauseEnrollmentSuccessResponse
object
Response returned when pausing an enrollment.
2 properties 2 required
PlaySummary
object
Play details embedded in sequence enrollment Bulk API results.
2 properties 2 required
ReplyEmailClassification
object
Reply email classification details embedded in sequence API results.
2 properties 2 required
ReplyEmailClassificationCategory
string
Reply classification category.
ReplyEmailMessage
object
Reply email message details embedded in sequence API results.
3 properties 3 required
ResumeEnrollmentSuccessResponse
object
Response returned when resuming an enrollment.
2 properties 2 required
SequenceCompany
object
Company details embedded in sequence Bulk API results.
5 properties 4 required
SequenceEnrollment
object
Sequence enrollment row returned by the sequence enrollments Bulk API.
17 properties 17 required
SequenceEnrollmentStatus
string
Status of a sequence enrollment.
SequenceMailbox
object
Mailbox details embedded in sequence Bulk API results.
6 properties 6 required
SequencePerson
object
Person details embedded in sequence Bulk API results.
6 properties 6 required
SequenceSummary
object
Minimal sequence details embedded in sequence enrollment Bulk API results.
2 properties 2 required
SequenceUser
object
User details embedded in sequence Bulk API results.
4 properties 4 required
UResponses.BadRequestError
object
Validation error detail returned for bad request responses.
4 properties 1 required
datetime
string
String value representing an RFC 3339 datetime.
email
string
String value representing an email address.
uuid
string
String UUID value.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

unify-sequence-enrollments-api-openapi.yml Raw ↑

Other APIs Unify publishes across the network.

Unify Analytics Events API
AE Profile APIs.io
Unify Event Query Jobs API
AE Profile APIs.io
Unify Objects API
AE Profile APIs.io
Unify Object Attributes API
AE Profile APIs.io
Unify Object Attribute Options API
AE Profile APIs.io
Unify Object Records API
AE Profile APIs.io
Unify Object Record Query Jobs API
AE Profile APIs.io
Unify Sequences API
AE Profile APIs.io
Unify Sequence Enrollment Steps API
AE Profile APIs.io
Unify Tasks API
AE Profile APIs.io
#Sequence Enrollments
← Back to U APIs
API Details
ID
unify:unify-sequence-enrollments-api
Base URL
https://api.unifygtm.com/sequences/v1
Docs
https://docs.unifygtm.com/developers/api/sequences/overview
Provider
Unify
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=unify-sequence-enrollments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/unify-sequence-enrollments-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Unify Sequence Enrollments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.