Skip to main content
POST
/
{partnerId}
/
deal
curl --request POST \
  --url https://mia-gateway.morada.ai/{partnerId}/deal \
  --header 'Content-Type: application/json' \
  --header 'x-morada-api-key: <api-key>' \
  --data '
{
  "name": "Joao Silva",
  "phoneNumber": "+5511999999999",
  "email": "joao@email.com",
  "productId": "prod-123",
  "source": "Website",
  "messageTemplate": "message_template_name",
  "replacements": [
    "Joao Silva"
  ]
}
'
{
  "dealId": "4d375b3b-0bfe-4326-8404-47b3e5a4c5d2",
  "message": "Deal created successfully"
}

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).

​
source
string
required

Origem do lead (ex: Website, Facebook, Simulador)

​
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

​
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 que podem ser usados em integracoes. Pode ser um objeto JSON ou uma JSON string.

​
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)