Mutations
An orientation to the write operations in the Awell Orchestration API and where to find them.
Queries read data; mutations change it. Use mutations to create and update patients, start and stop care flows, submit activities, and retry failed integrations. This page orients you to what's available and where to find it.
Mutations are grouped with their domain in the Reference section. The main write operations:
| Domain | Examples |
|---|---|
| Patients | createPatient, updatePatient, mergePatients, setPatientDataPointValue |
| Care flows | startPathway, stopPathway, pauseCareFlow, completeCareflow |
| Activities | retryActivity, expireActivity, completeExtensionActivity |
| Activity types | submitFormResponse, submitChecklist, markMessageAsRead |
| Tracks | addTrack, scheduleTrack, stopTrack |
| Hosted sessions & pages | startHostedPathwaySession, completeSession |
| API calls & webhooks | retryApiCall, retryWebhookCall |
Every mutation returns a payload with a code and success field — see
Errors for how to read them.
Related
- Getting started
- Browse the full write API under Reference.
Rate limits
Awell does not publish request-rate limits for the Orchestration API. What is documented is the per-query result cap, and how to behave when a request fails.
E.164 phone numbers
The Awell Orchestration API accepts phone numbers only in E.164 format: the validation rules applied, what they do and don't prove, and how to convert numbers stored another way.