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. To make a mutation safe to retry, send an
Idempotency-Key header — see Idempotent requests.
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.
Idempotent requests
How to make a mutation or an extension webhook delivery safe to retry with the Idempotency-Key header, what a replay returns, what Awell answers when a key is reused or still in flight, and the key Awell sends on its own outgoing API calls and webhooks.