Skip to main content
POST
Put someone into an automation

Authorizations

Authorization
string
header
required

An API token. The "read" ability: GET routes only. "read + write": every route.

Headers

Idempotency-Key
string

Replay a write safely: the same key gives back the first answer for 24 hours (header Idempotent-Replay: true).

Maximum string length: 255

Path Parameters

automation
string<uuid>
required

The automation's identifier (uuid).

Body

application/json
email
string<email>
required
first_name
string | null
last_name
string | null

Response

Journey started.

message
string
started
boolean