Skip to main content
Transition Enrollment

Authorizations

Authorization
string
header
required

Named syn_ API key or migration-only legacy key.

Headers

Idempotency-Key
string
required
Required string length: 1 - 255

Path Parameters

organization_id
string<uuid>
required
app_id
string<uuid>
required
environment_id
string<uuid>
required
enrollment_id
string<uuid>
required

Body

application/json
status
enum<string>
required
Available options:
active,
paused,
completed,
withdrawn

Response

Successful Response

cycle_count
integer
required
enrolled_at
string<date-time>
required
environment_id
string<uuid>
required
id
string<uuid>
required
program_id
string<uuid>
required
status
enum<string>
required
Available options:
active,
paused,
completed,
withdrawn
subject_id
string<uuid>
required
last_cycle_at
string<date-time> | null
next_due_at
string<date-time> | null
withdrawn_at
string<date-time> | null