PATCH
/
patients
/
{id}
Edit Patient
curl --request PATCH \
  --url https://api.axlehealth.com/api/v2-stable/patients/{id} \
  --header 'Content-Type: application/json' \
  --data '{
  "first_name": "<string>",
  "last_name": "<string>",
  "dob": "2023-12-25",
  "sex": "M",
  "external_id": "<string>",
  "email": "jsmith@example.com",
  "phone": "<string>",
  "addresses": [
    {
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip_code": "<string>"
    }
  ],
  "preferred_language": "<string>",
  "communication_settings": {
    "allows_automated_calls": true,
    "allows_clinician_calls": true,
    "allows_automated_sms": true,
    "allows_clinician_sms": true,
    "allows_automated_emails": true
  },
  "payers": [
    {
      "payer_id": "<string>"
    }
  ],
  "metadata": {}
}'
{}

Path Parameters

id
string<uuid>
required

The UUID of the patient to retrieve.

Body

application/json
first_name
string

First name of the patient (non-empty)

Minimum length: 1
last_name
string

Last name of the patient (non-empty)

Minimum length: 1
dob
string<date>

Date of birth of the patient

sex
enum<string>

Gender of the patient

Available options:
M,
F,
I,
U
external_id
string | null

Optional external identifier for the patient

email
string<email> | null

Optional email address of the patient

phone
string | null

Optional phone number of the patient

addresses
object[]
preferred_language
string

Preferred language of the patient

communication_settings
object

Optional settings for communication with patients

payers
object[] | null
metadata
object

Optional metadata related to the patient

Response

Patient details retrieved successfully

The response is of type object.