Skip to content

Set Sequence Status

POST
/sequences/{sequence_id}/status

Drive the status machine directly. PREFER THE NAMED TRANSITIONS.

/launch, /pause, /resume, /terminate and /archive each run the wind-down, scheduling and event work that belongs to them. This endpoint only SETS THE STATUS, so a sequence moved to terminated this way never emits its termination event and its workers are never wound down. It is exposed because the app exposes it and a rebuilt settings panel uses it - not because it is the way to stop a sequence.

The app’s state machine rejects an illegal transition.

Authorizations

Parameters

Path Parameters

sequence_id
required

Sequence id.

string

Sequence id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Drive the sequence status machine directly.

Prefer the named transitions (/launch, /pause, /resume, /terminate, /archive) - each runs the wind-down, scheduling and event work that belongs to it. This endpoint SETS THE STATUS, and the app’s state machine is what rejects an illegal transition.

object
status
required

Target status: drafted, scheduling, live, pausing, paused, resuming, terminating, terminated, completed or waiting. Declared as an open string rather than an enum so a status the sequencer adds is not rejected by a stale copy here - the app’s own SequenceStatus enum is the source of truth and an unknown value comes back as a 422 that LISTS the valid set.

string

Responses

200

Successful Response

object
data
required

One sequence, as the lifecycle endpoints return it.

object
associated_list_id
Any of:
integer
campaign_builder_campaign_id
Any of:
string
created_at
Any of:
string format: date-time
id
Any of:
string
is_archived
Any of:
boolean
is_shared
Any of:
boolean
name
Any of:
string
sequence_kind
Any of:
string
status
Any of:
string
updated_at
Any of:
string format: date-time
user_email
Any of:
string
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string