Marcações
Enviar resultados por e-mail
Enviar um e-mail ao cliente a avisar que os seus resultados laboratoriais estão prontos
POST
/
api
/
v1
/
appointments
/
{id}
/
results
/
email
curl --request POST \
--url https://anivahealth.com/api/v1/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a/results/email \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"with_reports": true,
"note": "Your vitamin D is low. We will talk about it at your next visit."
}'
{
"recipient_email": "maria.schmidt@example.com",
"attachment_count": 1,
"sent_at": "2026-10-15T09:12:44.512Z"
}
{
"error": "This customer has turned off emails. Turn emails on for them first.",
"reason": "unsubscribed"
}
Envia ao cliente um email a informar que os resultados laboratoriais estão prontos. O email é enviado para o
email do perfil da marcação.
O e-mail usa a marca genérica do parceiro: o nome e o logótipo do grupo de perfis principal do
perfil. Está no language do perfil, inglês por predefinição.
Define with_reports como true para anexar os relatórios laboratoriais da marcação. O email
anexa todos os relatórios que o cliente pode ver na app. Define-o como false
para enviar apenas o aviso. Adiciona note para mostrar uma nota pessoal no email, com um máximo de 1 000 caracteres.
Cada relatório anexado é um PDF encriptado com AES-256. A palavra-passe é a date_of_birth do
perfil em 8 dígitos, DDMMYYYY, sem pontos: um cliente nascido a 1 de fevereiro de 1985 escreve
01021985. O email indica este formato ao cliente, mas nunca a data de nascimento em si.
Cada chamada envia um email. As chamadas não são deduplicadas: se chamares o endpoint duas vezes, o cliente
recebe dois emails.
O email não é enviado quando:
- Ainda não chegou nenhum relatório laboratorial.
- O perfil não tem endereço de email, ou tem apenas um endereço provisório
@aniva.email. - O perfil desativou os emails transacionais. Para os voltar a ativar, define
transactional_emails_enabledcomotruecom Atualizar perfil. with_reportsétruee o perfil não temdate_of_birth. Define-a com Atualizar perfil, ou envia comwith_reports: false.
results_view.
Pedido
Parâmetros de caminho
Parâmetros do corpo
true anexa os relatórios laboratoriais como ficheiros PDF protegidos por palavra-passe. false envia apenas o aviso de que os resultados estão
prontos.Resposta
Em caso de sucesso, a API devolve200 OK.
Respostas de erro
Um corpo de erro temerror, uma mensagem legível por humanos, e reason, um código estável. Os erros de validação
e a falta do scope results_view não têm reason.
| Estado | Motivo | Descrição |
|---|---|---|
400 | — | Erro de validação — ID inválido, with_reports em falta, ou note com mais de 1 000 caracteres. |
403 | access_denied | Proibido — a tua chave API não tem o scope, ou a marcação está fora do teu contexto de acesso. |
404 | not_found | Marcação não encontrada. |
409 | no_reports | Ainda não chegou nenhum relatório laboratorial. |
409 | no_email | O perfil não tem endereço de email. |
409 | placeholder_email | O perfil tem apenas um endereço provisório @aniva.email. Atualiza o perfil com um email real. |
409 | unsubscribed | O perfil desativou os emails transacionais. Define primeiro transactional_emails_enabled como true. |
409 | no_birthdate | with_reports é true e o perfil não tem date_of_birth, a palavra-passe do PDF. |
413 | reports_too_large | Os relatórios são demasiado grandes para um só email. Envia o email com with_reports: false. |
422 | report_unprotectable | Um relatório não é um PDF, ou não foi possível protegê-lo com palavra-passe. Envia com with_reports: false. |
500 | — | Erro interno do servidor. |
502 | report_unavailable | Não foi possível carregar um relatório laboratorial. Nenhum email foi enviado. |
502 | send_failed | O fornecedor de email recusou o email. Nenhum email foi enviado. |
curl --request POST \
--url https://anivahealth.com/api/v1/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a/results/email \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"with_reports": true,
"note": "Your vitamin D is low. We will talk about it at your next visit."
}'
{
"recipient_email": "maria.schmidt@example.com",
"attachment_count": 1,
"sent_at": "2026-10-15T09:12:44.512Z"
}
{
"error": "This customer has turned off emails. Turn emails on for them first.",
"reason": "unsubscribed"
}
⌘I
curl --request POST \
--url https://anivahealth.com/api/v1/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a/results/email \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"with_reports": true,
"note": "Your vitamin D is low. We will talk about it at your next visit."
}'
{
"recipient_email": "maria.schmidt@example.com",
"attachment_count": 1,
"sent_at": "2026-10-15T09:12:44.512Z"
}
{
"error": "This customer has turned off emails. Turn emails on for them first.",
"reason": "unsubscribed"
}