Skip to main content
PATCH
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Path Parameters

id
string
required

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

Body

application/json
name
string

Internal name, shown in the dashboard.

trigger
object
exit
object
send_days
enum<string>[]

Weekdays a step may go out, in the business's time zone. Defaults to every day.

Available options:
sun,
mon,
tue,
wed,
thu,
fri,
sat
from
string | null

Sender address on the account's verified domain. Defaults to the account's sending address.

reply_to
string | null

Where replies go. Defaults to the account's Crevio inbox when exit.on_reply is on, otherwise the support email.

styled
boolean

Wrap each email in the branded layout. Defaults to true.

metadata
object

Caller-owned key/value pairs.

Response

The updated sequence

object
enum<string>
required
Available options:
sequence
id
string
required
name
string
required
status
enum<string>
required
Available options:
draft,
active,
paused
trigger
object
required
exit
object
required
send_days
enum<string>[]
required

Weekdays a step may go out, in the business's time zone. A step due on another day waits for the next allowed day at the same local time.

Available options:
sun,
mon,
tue,
wed,
thu,
fri,
sat
from
string | null
required
reply_to
string | null
required
styled
boolean
required
steps
object[]
required

Live steps in send order.

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