Update Profile

PATCH

api

profiles

{id}

curl --request PATCH \
  --url https://anivahealth.com/api/v1/profiles/a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "phone": "+4917612345678",
    "language": "en"
  }'

{
  "id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
  "handle": null,
  "first_name": "Maria",
  "last_name": "Schmidt",
  "email": "maria.schmidt@example.com",
  "phone": "+4917612345678",
  "sex": 2,
  "date_of_birth": "1985-03-22",
  "height": 168,
  "weight": 65,
  "language": "en",
  "transactional_emails_enabled": true,
  "created_at": "2026-04-01T09:14:32Z",
  "updated_at": "2026-04-01T14:22:11Z"
}

{
  "error": "phone must be a valid E.164 phone number"
}

{
  "error": "Profile not found"
}

Update one or more fields on an existing patient profile. You only need to include the fields you want to change — all body parameters are optional.

Request

Path parameters

string

required

Unique identifier (UUID) of the profile to update.

Body parameters

string

New email address for the profile.

string

New password. Must be between 8 and 128 characters.

string

New first name. Must use latin characters, between 1 and 100 characters.

string

New last name. Must use latin characters, between 1 and 100 characters.

string

New phone number in E.164 format (e.g., +14155552671).

integer

New biological sex value per ISO/IEC 5218 (0 = unknown, 1 = male, 2 = female).

string

New date of birth in YYYY-MM-DD format.

number

New height in centimeters.

number

New weight in kilograms.

string

New preferred language. Accepted values: en, de, fi.

boolean

Whether this profile should receive transactional (programmatic) emails — appointment confirmations, result-ready notices, etc. Overrides the profile group default. Distinct from marketing opt-in. Omit to use the default.

Response

On success, the API returns 200 OK with the full updated profile.

string

required

Unique profile identifier (UUID).

string

Profile handle or username. May be null.

string

First name. May be null.

string

Last name. May be null.

string

Email address. May be null.

string

Phone number in E.164 format. May be null.

integer

Biological sex per ISO/IEC 5218 (0 = unknown, 1 = male, 2 = female). May be null.

string

Date of birth in YYYY-MM-DD format. May be null.

number

Height in centimeters. May be null.

number

Weight in kilograms. May be null.

string

Preferred language (en, de, or fi).

boolean

Whether this profile receives transactional (programmatic) emails. null when never set.

string

ISO 8601 timestamp of when the profile was created.

string

ISO 8601 timestamp of the last update. May be null.

Error responses

Status	Description
`400`	Validation error — one or more fields failed validation.
`403`	Forbidden — your API key does not have access to this operation or the profile is outside your access context.
`404`	Profile not found.
`500`	Internal server error.

curl --request PATCH \
  --url https://anivahealth.com/api/v1/profiles/a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "phone": "+4917612345678",
    "language": "en"
  }'

{
  "id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
  "handle": null,
  "first_name": "Maria",
  "last_name": "Schmidt",
  "email": "maria.schmidt@example.com",
  "phone": "+4917612345678",
  "sex": 2,
  "date_of_birth": "1985-03-22",
  "height": 168,
  "weight": 65,
  "language": "en",
  "transactional_emails_enabled": true,
  "created_at": "2026-04-01T09:14:32Z",
  "updated_at": "2026-04-01T14:22:11Z"
}

{
  "error": "phone must be a valid E.164 phone number"
}

{
  "error": "Profile not found"
}

Get Profile

List Appointments

curl --request PATCH \
  --url https://anivahealth.com/api/v1/profiles/a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "phone": "+4917612345678",
    "language": "en"
  }'

{
  "id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
  "handle": null,
  "first_name": "Maria",
  "last_name": "Schmidt",
  "email": "maria.schmidt@example.com",
  "phone": "+4917612345678",
  "sex": 2,
  "date_of_birth": "1985-03-22",
  "height": 168,
  "weight": 65,
  "language": "en",
  "transactional_emails_enabled": true,
  "created_at": "2026-04-01T09:14:32Z",
  "updated_at": "2026-04-01T14:22:11Z"
}

{
  "error": "phone must be a valid E.164 phone number"
}

{
  "error": "Profile not found"
}

Health

Profiles

Appointments

Home Kit Orders

Biomarkers

Panels

Units

Locations

Documents

Shipments

Update Profile

Request

Path parameters

Body parameters

Response

Error responses

​Request

​Path parameters

​Body parameters

​Response

​Error responses

Request

Path parameters

Body parameters

Response

Error responses