Create Profile

POST

api

profiles

curl --request POST \
  --url https://anivahealth.com/api/v1/profiles \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "first_name": "Maria",
    "last_name": "Schmidt",
    "sex": 2,
    "date_of_birth": "1985-03-22",
    "profile_group": "acme-clinic-berlin",
    "email": "maria.schmidt@example.com",
    "phone": "+4930123456789",
    "height": 168,
    "weight": 65,
    "language": "de",
    "transactional_emails_enabled": true,
    "marketing_emails_enabled": false
  }'

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

{
  "error": "date_of_birth must be a date in the past"
}

{
  "error": "Profile group not found"
}

Create a new patient profile and assign it to a profile group. The profile holds demographic data used across appointments and lab orders.

Request

Body parameters

string

required

First name of the patient. Must use latin characters, between 1 and 100 characters.

string

Last name of the patient. Must use latin characters, between 1 and 100 characters.

integer

required

Biological sex per ISO/IEC 5218. Use 0 for unknown, 1 for male, 2 for female.

string

required

Date of birth in YYYY-MM-DD format. Must be a date in the past.

string

required

Polymorphic reference (UUID or slug) to the profile group to assign this profile to. The UUID is the immutable identifier and survives slug renames; the slug remains accepted for marketing and partner integrations built on readable identifiers. UUID is preferred. The profile group must be within your API key’s access context.

string

Email address for the profile. If omitted, Aniva auto-generates an email address.

string

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

number

Height in centimeters.

number

Weight in kilograms.

string

default:"en"

Preferred language for the profile. Accepted values: en, de, fi. Defaults to en.

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.

boolean

Whether this profile opts in to marketing emails (newsletters, product updates). Overrides the profile group default. Distinct from transactional emails. Omit to use the profile group default. Write-only: not returned in the profile response.

Response

On success, the API returns 201 Created with the newly created 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. null for newly-created profiles.

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 group is outside your access context.
`404`	Profile group not found.
`500`	Internal server error.

curl --request POST \
  --url https://anivahealth.com/api/v1/profiles \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "first_name": "Maria",
    "last_name": "Schmidt",
    "sex": 2,
    "date_of_birth": "1985-03-22",
    "profile_group": "acme-clinic-berlin",
    "email": "maria.schmidt@example.com",
    "phone": "+4930123456789",
    "height": 168,
    "weight": 65,
    "language": "de",
    "transactional_emails_enabled": true,
    "marketing_emails_enabled": false
  }'

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

{
  "error": "date_of_birth must be a date in the past"
}

{
  "error": "Profile group not found"
}

List Profiles

Get Profile

curl --request POST \
  --url https://anivahealth.com/api/v1/profiles \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "first_name": "Maria",
    "last_name": "Schmidt",
    "sex": 2,
    "date_of_birth": "1985-03-22",
    "profile_group": "acme-clinic-berlin",
    "email": "maria.schmidt@example.com",
    "phone": "+4930123456789",
    "height": 168,
    "weight": 65,
    "language": "de",
    "transactional_emails_enabled": true,
    "marketing_emails_enabled": false
  }'

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

{
  "error": "date_of_birth must be a date in the past"
}

{
  "error": "Profile group not found"
}

Health

Profiles

Appointments

Home Kit Orders

Biomarkers

Panels

Units

Locations

Documents

Shipments

Create Profile

Request

Body parameters

Response

Error responses

​Request

​Body parameters

​Response

​Error responses

Request

Body parameters

Response

Error responses