Skip to main content
PATCH
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

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
subject
string

Takes the same variables as body.

preview_text
string | null

Inbox preview line. Takes the same variables as body.

Maximum string length: 255
body
string

Email body (HTML or plain text). Variables, filled per recipient: {{customer.first_name}}, {{customer.last_name}}, {{customer.email}}, {{business.name}}, {{product.name}}, {{product.url}}, {{order.product_names}}, {{tag.name}}, {{form.name}}, {{customer.fields.}}. product.* is the product whose purchase enrolled them (order.paid sequences only), tag.name the tag that enrolled them (tag_added), form.name the form a new lead came through (lead_created, empty for leads from elsewhere). customer.fields.<key> reads <key> from the customer's metadata when the email is sent; the key takes letters, digits and underscores. A blank value renders as nothing, or as the default in {{ customer.first_name | default: "there" }}. Any other {{ }} is rejected.

delay
object

Wait after the previous step's send (after enrolling, for the first step).

position
integer

1-based place in the sequence. On create, omit to append; the step at that place and those after it move down one.

Required range: x >= 1

Response

The updated step

object
enum<string>
required
Available options:
sequence_step
id
string
required
sequence
string
required
position
integer
required
subject
string
required
preview_text
string | null
required
body
string
required
delay
object
required

Wait after the previous step's send (after enrolling, for the first step).

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