Encomendas de kits de teste em casa
Enviar resultados por e-mail
Enviar um email ao cliente a informar que os resultados laboratoriais do seu kit de teste em casa estão prontos
POST
/
api
/
v1
/
home-kit-orders
/
{id}
/
results
/
email
curl --request POST \
--url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a/results/email \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"with_reports": true
}'
{
"recipient_email": "maria.schmidt@example.com",
"attachment_count": 1,
"sent_at": "2026-10-15T09:12:44.512Z"
}
{
"error": "No lab report has arrived yet.",
"reason": "no_reports"
}
Envia ao cliente um e-mail a avisar que os resultados de laboratório estão prontos. O e-mail é enviado para o
email do perfil da encomenda de kit de teste em casa.
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 de laboratório do kit. O e-mail
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 e-mail, com no máximo 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 de laboratório.
- O perfil não tem endereço de e-mail, ou tem apenas um endereço provisório
@aniva.email. - O perfil desativou os e-mails transacionais. Para os voltar a ativar, define
transactional_emails_enabledcomotruecom Atualizar perfil. with_reportsétruee o perfil não temdate_of_birth. Define este campo com Atualizar perfil ou envia comwith_reports: false.- A encomenda é uma das encomendas de kit de teste em casa de demonstração. Uma encomenda de demonstração não tem nenhum cliente a quem enviar e-mail.
results_view e o scope home_kit_orders_view ou home_kit_orders_manage.
Pedido
Parâmetros de caminho
Identificador único (UUID) da encomenda de kit de teste em casa cujos resultados queres enviar por e-mail.
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 de API não tem os scopes necessários ou a encomenda de kit de teste em casa está fora do teu contexto de acesso. |
404 | not_found | Encomenda de kit de teste em casa não encontrada. |
409 | demo_order | A encomenda é uma encomenda de kit de teste em casa de demonstração. Não tem nenhum cliente a quem enviar e-mail. |
409 | no_reports | Ainda não chegou nenhum relatório de laboratório. |
409 | no_email | O perfil não tem endereço de e-mail. |
409 | placeholder_email | O perfil tem apenas um endereço provisório @aniva.email. Atualiza o perfil com um e-mail real. |
409 | unsubscribed | O perfil desativou os e-mails 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ó e-mail. Envia o e-mail 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 de laboratório. Não foi enviado nenhum e-mail. |
502 | send_failed | O fornecedor de e-mail recusou o e-mail. Não foi enviado nenhum e-mail. |
curl --request POST \
--url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a/results/email \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"with_reports": true
}'
{
"recipient_email": "maria.schmidt@example.com",
"attachment_count": 1,
"sent_at": "2026-10-15T09:12:44.512Z"
}
{
"error": "No lab report has arrived yet.",
"reason": "no_reports"
}
⌘I
curl --request POST \
--url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a/results/email \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"with_reports": true
}'
{
"recipient_email": "maria.schmidt@example.com",
"attachment_count": 1,
"sent_at": "2026-10-15T09:12:44.512Z"
}
{
"error": "No lab report has arrived yet.",
"reason": "no_reports"
}