Pular para o conteúdo principal
POST
Enviar para assinatura

Autorizações

Authorization
string
header
obrigatório

A chave do app de integração, criada em Integrações. Escopos: patients:read (Listar, buscar e ler pacientes; os eventos patient..); patients:write (Criar e editar pacientes. Inclui ler.); anamneses:read (Listar e ler anamneses, sem as respostas; os eventos anamnesis..); anamneses:write (Enviar, reenviar e cancelar anamnese. Inclui ler.); anamneses:answers (Ler as respostas da anamnese preenchida. É dado de saúde.); documents:read (Atendimentos, documentos, status da assinatura e o PDF; os eventos appointment.* e signature_request.*.); documents:write (Gerar contrato e termos e enviar para assinatura, reenviar e cancelar. Inclui ler.); catalog:read (Procedimentos, prestadores e modelos de documento da clínica.); webhooks:write (Criar, alterar e remover os webhooks do próprio app pela API.)

Cabeçalhos

Idempotency-Key
string<uuid>

Um uuid. A mesma chave nas 24 horas devolve a mesma resposta, sem repetir o efeito; com outro corpo, ou enquanto a primeira chamada ainda roda, 409. A resposta repetida não traz o segredo do webhook.

Parâmetros de caminho

id
string<uuid>
obrigatório

Corpo

application/json
channels
enum<string>
obrigatório
Opções disponíveis:
whatsapp,
email,
both

Resposta

Criado.

data
object
obrigatório

O atendimento depois do envio ou do reenvio, com a hora em que a mensagem sai.