Skip to main content
POST
Enroll/Remove Contacts in Workflow

Authorizations

Authorization
string
header
required

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

Path Parameters

workflow_id
string<uuid>
required

Query Parameters

testing
boolean
default:false

When true, bypass the duplicate-enrollment guard.

Body

contact_id
string<uuid>
contact_ids
any

Array of UUIDs, or the literal string "all".

filters
any

Advanced contact filter; only applied when contact_ids="all".

limit
integer
scheduled_at
string

Local ISO datetime (e.g. 2026-03-15T14:30:00).

Minimum string length: 1
timezone
string

IANA timezone for scheduled_at. Required when scheduled_at is provided.

Minimum string length: 1

Response

added
integer
required
skipped
integer
required

Sum of contacts not found and contacts already enrolled.

total_matching
integer