Cases

Update Case Status

Move a case. closed_at is derived from the status, not supplied.

patch/api/v1/cases/{case_id}

Path parameters

case_idstring required

status'IN_PROGRESS' | 'NEEDS_ACTION' | 'READY' | 'CANCELLED' required

Successful Response

idstring required

external_idstring required

status'IN_PROGRESS' | 'NEEDS_ACTION' | 'READY' | 'CANCELLED' required

patient_idstring required

payorstring nullable required

planstring nullable required

member_idstring nullable required

appointment_external_idstring nullable required

appointment_atstring date-time nullable required

appointment_typestring nullable required

cpt_codesstring[] required

locationobject required

providerobject required

custom_dataobject required

source_urlstring nullable required

closed_atstring date-time nullable required

created_atstring date-time required

Changed in 3 of the 12 revisions of this API.14

Aug 2, 20266a15543258a512See the full diff
- ▲
  removed the enum value BLOCKED of the request property status
  request-property-enum-value-removed
- ○
  removed the BLOCKED enum value from the status response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the QUEUED enum value from the tasks/items/status response property for the response status 200
  response-property-enum-value-removed
Aug 1, 202643f85a5ab3481See the full diff
- ○
  added the required property source_url to the response with the 200 status
  response-required-property-added
Jul 31, 2026bd124844fd9f1See the full diff
- ○
  endpoint added
  endpoint-added