Skip to main content
POST
cURL

Overview

Agentic sequences generate a draft for each person and wait for approval before the enrollment starts. While an enrollment waits, is_draft_approval_pending is true. Approve the enrollment after reviewing its copy. Approval starts the enrollment, and automatic emails follow the sequence’s send schedule. The API returns 409 Conflict when the enrollment is not waiting for approval, for example because it was already approved or was canceled. It returns 400 Bad Request when the person has opted out of email or is marked do not email.

Examples

Set UNIFY_API_KEY to your API key and replace the example enrollment ID. First, list the enrollment’s steps to review the drafted copy:
Use Update enrollment step to revise any email. When the copy is ready, approve the enrollment:
A successful response sets is_draft_approval_pending to false. You can still update steps that have not sent.

Authorizations

x-api-key
string
header
required

Path Parameters

id
string<uuid>
required

String UUID value.

Response

Response returned when a draft enrollment is approved.

Response returned when a draft enrollment is approved.

id
string<uuid>
required

String UUID value.

is_draft_approval_pending
enum<boolean>
required
Available options:
false