Skip to main content
POST
Submit a care job

Authorizations

Authorization
string
header
required

OAuth 2.1 with PKCE

Headers

Idempotency-Key
string

Reuse the same key when retrying this exact create; the original result is replayed instead of creating a second job

Body

application/json
jobType
enum<string>
required
Available options:
move_referral,
book_appointment,
cancel_or_reschedule
patientId
string

Which patient on the account this is for (from GET /api/profile). Omit for the default patient.

params
object

Action-specific fields. move_referral: specialty, referral {description (required), writtenApprox?, referenceNumber?}, source {providerName?, facilityName?, phone?}, target {npi | providerName, city, state, facilityName?, address?, phone?}, optional appointmentLabel, estimates, savingsCents, openings. book_appointment: provider {npi | providerName, city, state, ...}, specialty?, appointmentLabel?, reason?, estimates?. cancel_or_reschedule: appointmentLabel, provider {...}, newTimeLabel?.

context
string

Short plain-language reason, shown on the approval sheet attributed as the agent's note

cost
object

Only for cost-bearing actions. The sheet collects a manual-capture hold; capture happens on completion.

idempotencyKey
string

Alternative to the Idempotency-Key header

Response

Request created, awaiting the user's approval

status
enum<string>
Available options:
pending_approval
jobId
string
jobType
string
tier
string

Approval tier, assigned server-side

approvalUrl
string<uri>

Hand to the user. Never open it yourself. Expires 15 minutes after creation.

expiresAt
sheet
object

What the user will see on the approval sheet

agentInstructions
string[]