Skip to main content
POST
Enroll contact in flow

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
integer
required

Body

application/json

Enroll a contact into a flow. Scramble reads these rules to document the request body. Identify the contact by contact_id (a contact already in the workspace) OR by phone (the contact is looked up by its E.164 number). Exactly one is required; the controller resolves it to a Contact and hands it to FlowEnrollmentService::enroll().

contact_id
integer | null

Id of an existing contact in the workspace. Required unless phone is given.

phone
string | null

Contact phone in international format (digits, E.164). Used to look up the contact when contact_id is omitted. Required unless contact_id is given.

Maximum string length: 32

Response

Resource created successfully.

data
object
required
meta
string
required