Saltar para o conteúdo principal
POST
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_enabled como true com Atualizar perfil.
  • with_reports é true e o perfil não tem date_of_birth. Define este campo com Atualizar perfil ou envia com with_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.
Requer o scope results_view e o scope home_kit_orders_view ou home_kit_orders_manage.

Pedido

Parâmetros de caminho

string
obrigatório
Identificador único (UUID) da encomenda de kit de teste em casa cujos resultados queres enviar por e-mail.

Parâmetros do corpo

boolean
obrigatório
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.
string
Uma nota pessoal que o email mostra abaixo do aviso. No máximo 1 000 caracteres.

Resposta

Em caso de sucesso, a API devolve 200 OK.
string
obrigatório
O endereço para onde o email foi enviado: o email do perfil.
integer
obrigatório
O número de relatórios laboratoriais anexados. 0 quando with_reports é false.
string
obrigatório
Quando o email foi enviado, como um instante UTC (ISO 8601 com sufixo Z).

Respostas de erro

Um corpo de erro tem error, 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.