Skip to main content
POST
Enrol in 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
to
string
required

The contact's number, with or without the +. Matched to an existing contact by its digits.

Example:

"+91 98765 43210"

variables
object

Values the sequence's messages can use. At most 20; each name 1–60 characters (a longer one is refused); values are text, numbers or true/false, stored as text and cut at 300 characters. An object or list as a value is refused.

Example:

Response

Whether they were enrolled. Branch on enrolled.

enrolled
boolean
required

Whether they were put into the sequence.

id
string<uuid>

The enrolment's id, when enrolled.

reason
string

When not enrolled: the four possible reasons, together.