Evento#
| Campo | Obrigatório | Regra |
|---|---|---|
id | sim | Único por evento no seu sistema, até 128 caracteres. Identifica o conteúdo: veja as regras. |
type | sim | deal.upserted ou deal.deleted. |
occurredAt | sim | Quando a mudança aconteceu no seu sistema. ISO 8601 com fuso (-03:00 ou Z). Até 5 minutos no futuro. |
Contato (contact)#
Obrigatório em deal.upserted.
| Campo | Obrigatório | Regra |
|---|---|---|
externalId | sim | Id do paciente no seu sistema, até 128 caracteres. Precisa ser estável: o mesmo paciente sempre com o mesmo id. |
phone | recomendado | Qualquer formato: com ou sem +55, com máscara, com ou sem o nono dígito. Nós normalizamos. É o principal elo com a origem do lead. |
email | não | Até 200 caracteres. Também usado para encontrar o lead. |
name | não | Até 200 caracteres. Completa o lead quando o nome estiver vazio do nosso lado. |
Dica
Sempre que tiver o telefone do paciente, envie. Sem telefone nem e-mail, não há como ligar o orçamento à página ou campanha de origem, e ele entra como um lead novo.
Orçamento (deal)#
| Campo | Obrigatório | Regra |
|---|---|---|
externalId | sim | Id do orçamento no seu sistema, até 128 caracteres. |
status | sim | open (em aberto), won (fechado ou pago) ou lost (perdido). |
amount | sim | Valor total em reais, como número: 350.5, não "350,50". Entre 0 e 10.000.000. |
currency | não | Somente BRL. |
stage | não | Nome da etapa no seu sistema, até 120 caracteres. Só exibição. |
lostReason | não | Motivo da perda, até 300 caracteres. Não inclua informação clínica. |
openedAt | recomendado | ISO 8601 com fuso. Decide qual visita ao site recebe o crédito da venda. |
closedAt | não | ISO 8601 com fuso. Data do fechamento ou da perda. |
attendant | não | Nome de quem atendeu, até 120 caracteres. |
origin | não | Origem registrada no seu sistema ("Instagram", "Indicação"), até 120 caracteres. |
items | não | Pode omitir. Se vier, é descartado: nome de exame é dado de saúde e não é armazenado. |
Como o orçamento encontra o lead#
Para um orçamento novo, procuramos o lead mais recente do mesmo paciente (pelo telefone, pelo e-mail ou por orçamentos anteriores do mesmo contact.externalId) criado até a abertura do orçamento. É o lead que trouxe o paciente, e é a origem dele que recebe o crédito da venda.
Uma vez ligado, o orçamento continua no mesmo lead em todas as atualizações seguintes.