Skip to main content
POST

Authorizations

x-morada-api-key
string
header
required

Chave de API do parceiro. Fornecida pelo time da Morada.ai.

Path Parameters

partnerId
string
required

ID do parceiro

Body

application/json
name
string
required

Nome completo do lead

phoneNumber
required

Telefone valido do lead com DDD. DDI e opcional (assume 55 se ausente).

email
string<email>

Email valido do lead

productId
string

ID do produto/propriedade na plataforma M.I.A

productExternalId
string

ID externo do produto no CRM ou plataforma do cliente

partnerId
string

ID do parceiro (caso nao venha pelo path)

conversionIdentifier
string

Identificador da conversao para rastreamento

bypassProductCheck
boolean

Pular validacao de produto

source
string

Onde o lead apareceu (ex: Facebook, Google, Site, RD Conversas). Sem este campo, grava "Não definido (Morada.ai)".

Maximum string length: 255
campaign
string

Campanha ou anuncio que gerou o lead. Sem este campo, vale extras.campaign.

Maximum string length: 255
medium
string

Tipo de midia (ex: cpc, lead-ads, whatsapp). Sem este campo, vale extras.medium; sem nenhum dos dois, grava "API Morada.ai".

Maximum string length: 255
messageTemplate
string

Template de mensagem WhatsApp para iniciar conversa com a MIA

replacements
string[]

Substituicoes para os placeholders do template

instanceId

ID da instancia do bot

externalId

ID externo do deal

variantId
string

ID da variante

extras

Dados extras usados nas integracoes. Pode ser um objeto JSON ou uma JSON string. Tambem aceita campaign e medium, com prioridade menor que os campos da raiz.

specialInstructions
string

Instrucoes especiais para a MIA durante a conversa

Response

Deal criado ou atualizado com sucesso

dealId
string

Identificador unico do deal criado

message
string

Mensagem descritiva do resultado da operacao

conversationId
string

ID da conversa (quando ja existia uma conversa aberta)

skipped
boolean

Indica se a criacao foi pulada (ex: horario de atendimento)