Skip to main content
POST
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Headers

Idempotency-Key
string

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Maximum string length: 255

Path Parameters

sequence_id
string
required

The sequence's prefixed id (e.g. seq_abc123).

Body

application/json
customer_id
string

The customer (cus_...) to enroll.

email
string

Or an email address; an unknown one is added as a lead.

Response

The person's existing enrollment

object
enum<string>
required
Available options:
sequence_enrollment
id
string
required
sequence
string
required
customer
string
required
email
string
required
status
enum<string>
required
Available options:
pending_confirmation,
active,
completed,
unsubscribed,
suppressed,
purchased,
excluded,
replied,
canceled,
customer_deleted,
sequence_deleted,
failed
source
string
required

What enrolled them: api, or the event name (lead.created, customer.tag_added, order.paid).

next_step
string | null
required
next_send_at
string<date-time> | null
required

When the next step goes out, after send days are applied. Null once the enrollment stops or while it waits for double opt-in.

started_at
string<date-time> | null
required
last_sent_at
string<date-time> | null
required
ended_at
string<date-time> | null
required
deliveries
object[]
required

Steps sent to this person, oldest first.

created_at
string<date-time>
required
updated_at
string<date-time>
required