Skip to main content
POST
Preview a step

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).

id
string
required

The step's prefixed id (e.g. seqst_abc123).

Body

application/json
customer_id
string

Render as this customer (cus_...). Omit to use every variable's default.

Response

The rendered email

An email rendered for one customer exactly as they would receive it, without sending it.

object
enum<string>
required
Available options:
email_preview
subject
string
required

The subject with its variables filled in.

preview_text
string
required

The inbox preview line with its variables filled in, or empty.

html
string
required

The whole email, layout included. Its unsubscribe link is a placeholder that unsubscribes nobody.

data_source
enum<string>
required

Whose data filled the variables: none (no customer_id, so every variable uses its default), customer (their details as they are now), enrollment (a sequence step for someone enrolled: what they joined with), latest_order (not enrolled, so product and order variables come from their latest order) or no_order (not enrolled and no order, so those variables are blank).

Available options:
none,
customer,
enrollment,
latest_order,
no_order