Skip to main content
POST
Enrol a contact or list into a flow

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Path Parameters

id
string
required

Flow identifier.

Body

application/json
contact_id
string

Enrol this single contact. Mutually exclusive with list_id.

Maximum string length: 200
list_id
string

Enrol every member of this list (max 500). Mutually exclusive with contact_id.

Maximum string length: 200
context
object

Extra context merged into the flow's trigger data.

Response

Enrolment accepted. Single-contact mode returns the execution row; list mode returns the number enrolled.

data
object
meta
object