Skip to main content
POST
Start a Workflow Run

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. Refused with 404 (Workspace not found.) when the id is unknown, is not one of your customers, or is not an org_… id; 410 when that customer was deleted (restore it with POST /customers/{id}/restore until it is erased); 403 when the key belongs to one customer workspace (it cannot act as another); 400 when your workspace is not a developer workspace. /customers/* and GET /customers/usage are your own workspace's and refuse the header with 400: call them without it.

Example:

"org_3fKq9TzQ1mN8vB2xR7cLpA"

Path Parameters

workflowId
string
required

The workflow's id (wf_…). With Start when set to Your system asks, the builder shows this endpoint with the id, ready to copy. A bare uuid also works.

Body

application/json
to
string
required

The contact's phone number, with its country code.

name
string

Their name, used for a new contact and for {{contact.name}}.

email
string

Their email, used for a new contact.

variables
object

Up to 20 values for this run (text, numbers or true/false; names up to 60 characters, values up to 300). Not name, email or phone: send those as fields.

Response

Not started: already going through it, or not allowed through it again. Branch on started.

started
boolean
required

Whether the contact was started through the workflow.

reason
string

Why not, when started is false.