Profiles
Create Profile
Create a new patient profile and assign it to a profile group
POST
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
First name of the patient. Must use latin characters, between 1 and 100 characters.
Last name of the patient. Must use latin characters, between 1 and 100 characters.
Biological sex per ISO/IEC 5218. Use
1 for male and 2 for female.Date of birth in
YYYY-MM-DD format. Must be a date in the past.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. Either
profile_group or the deprecated
profile_group_slug must be provided; UUID is preferred. The profile group must be within your
API key’s access context.Deprecated — use
profile_group. Slug of the profile group to assign this profile to. Still
accepted for backward compatibility with older integrations.Email address for the profile. If omitted, Aniva auto-generates an email address.
Phone number in E.164 format (e.g.,
+14155552671).Height in centimeters.
Weight in kilograms.
Preferred language for the profile. Accepted values:
en, de, fi. Defaults to en.Response
On success, the API returns201 Created with the newly created profile.
Unique profile identifier (UUID).
Profile handle or username. May be
null.First name. May be
null.Last name. May be
null.Email address. May be
null.Phone number in E.164 format. May be
null.Biological sex per ISO/IEC 5218 (
1 = male, 2 = female). May be null.Date of birth in
YYYY-MM-DD format. May be null.Height in centimeters. May be
null.Weight in kilograms. May be
null.Preferred language (
en, de, or fi).ISO 8601 timestamp of when the profile was created.
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. |