Enrollments
Create enrollment
Enroll a person in a sequence.
POST
cURL
Overview
Create an enrollment to add a person to a published template sequence. The sequence’s ruleset determines enrollment eligibility.Examples
Enroll a trial signup
Enroll a trial signup
Use an existing person and a published template sequence. Set Creating an enrollment starts the sequence’s workflow, which can send emails
and create tasks. Review the sequence, recipient, and sending mailbox before
running the request. Save the returned enrollment ID to inspect or pause it
later.
UNIFY_API_KEY
to your API key, replace the example IDs, and use an eligible connected sending
mailbox:Handle enrollment conflicts
When active enrollments prevent a new enrollment, the API returns409 Conflict. Inspect reason and active_enrollments; the response can also
include blocking_sequence_ids or unapproved_sequence_ids.
If user approval is required, present the active enrollments for review before
retrying with allowed_concurrent_sequence_ids. Those IDs record the user’s
approval. Enrollment must still satisfy the sequences’ simultaneous enrollment
policies.
Other eligibility failures return 400 Bad Request with a message explaining
the cause. Examples include an unpublished sequence, ineligible mailboxes,
opt-outs, exclusions, and re-enrollment restrictions. Resolve that cause before
retrying.
Agentic sequences use the workflow for generating drafts
in Unify. This endpoint returns 400 Bad Request for an agentic sequence. After
Unify generates the drafts, you can review and edit their copy with
List enrollment steps and
Update enrollment step, then
start each enrollment with Approve enrollment.Body
application/json
Request body for enrolling a person in a sequence.
Response
Response returned when an enrollment is created.
Response returned when an enrollment is created.
cURL