Skip to main content
PATCH
Update Sequence

Authorizations

Authorization
string
header
required

Your API key (ta_live_…) from Settings → API keys, sent as Authorization: Bearer <key>. Keep it on a server: it can message every customer you have. A key is full, build or read-only; a request its level does not allow is refused with 403.

Headers

Thinnest-Workspace
string

Developers only: the customer workspace this request acts in — its org_… id from POST /customers. Leave it out to act in your own workspace.

Example:

"org_3fKq9TzQ1mN8vB2xR7cLpA"

Path Parameters

sequenceId
string<uuid>
required

The sequence's id — a bare uuid.

Body

application/json

Any of these; at least one. agent cannot be changed.

name
string

What you call it.

Required string length: 1 - 120
exitOnReply
boolean

Whether a reply from the customer takes them out.

triggerTags
string[]

Replaces the enrolling tags.

exitOnTags
string[]

Replaces the exit tags.

startOn
string[]

Replaces the events that enrol the contact.

stopOn
string[]

Replaces the events that take them out. Checked against startOn as stored when you send only one side.

Response

The sequence as saved.

id
string<uuid>
required

The sequence's id — a bare uuid.

name
string
required

The sequence's name.

status
enum<string>
required

Only active sequences send.

Available options:
draft,
active,
paused
agent
string
required

The agent it belongs to (ag_…).

exitOnReply
boolean
required

Whether a reply from the customer takes them out.

triggerTags
string[]
required

Tagging a contact with one of these enrols them.

exitOnTags
string[]
required

Tagging someone in it with one of these takes them out.

startOn
string[]
required

Event names (Report Event) that enrol the contact.

stopOn
string[]
required

Event names that take them out.

steps
object[]
required

The messages, in order.

enrolments
object
required

How many people are in it now, have finished it, and left it early.

createdAt
string<date-time>
required

When it was created.