Perfis
Atualizar perfil
Atualizar um perfil de paciente existente
PATCH
/
api
/
v1
/
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: Phone must be in E.164 format (e.g., +14155552671)"
}
{
"error": "Profile not found"
}
Atualiza um ou mais campos num perfil de paciente existente. Só precisas de incluir os campos que queres alterar — todos os parâmetros do corpo são opcionais.
Requer o scope
create_user.
Pedido
Parâmetros de caminho
Parâmetros do corpo
Novo valor de sexo biológico segundo a norma ISO/IEC 5218 (
1 = masculino, 2 = feminino). 0 (desconhecido) devolve 400.Nova data de nascimento no formato
YYYY-MM-DD. Tem de estar no passado e não ser anterior a 1900. A idade
implícita tem de estar entre 16 e 100 anos.Novo idioma preferido:
en, bg, ca, cs, da, de, el, es, et, fi, fr, ga, hr, hu, is, it, lb, lt, lv, mt, nl, no, pl, pt, ro, ru, sk, sl, sr, sv, tr ou uk.Define se este perfil deve receber emails transacionais (programáticos) — confirmações
de marcação, avisos de resultados prontos, etc. Distinto do consentimento de marketing. Omite para manter
o valor atual.
Resposta
Em caso de sucesso, a API devolve200 OK com o perfil completo atualizado.
Sexo biológico segundo a norma ISO/IEC 5218 (
0 = desconhecido, 1 = masculino, 2 = feminino). Pode ser null.Indica se este perfil recebe emails transacionais (programáticos).
null quando nunca foi definido.Respostas de erro
| Estado | Descrição |
|---|---|
400 | Erro de validação — um ou mais campos falharam na validação. |
403 | Proibido — a tua chave de API não tem acesso a esta operação ou o perfil está fora do teu contexto de acesso. |
404 | Perfil não encontrado. |
500 | Erro interno do servidor. |
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: Phone must be in E.164 format (e.g., +14155552671)"
}
{
"error": "Profile not found"
}
⌘I
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: Phone must be in E.164 format (e.g., +14155552671)"
}
{
"error": "Profile not found"
}