Skip to main content
POST
/
send-notification
curl --request POST \
  --url https://mia-gateway.morada.ai/send-notification \
  --header 'Content-Type: application/json' \
  --header 'x-morada-api-key: <api-key>' \
  --data '
{
  "name": "Nome do Cliente",
  "phoneNumber": "(11) 999999999",
  "email": "cliente@exemplo.com",
  "instanceId": 1234,
  "source": "Origem",
  "template": {
    "name": "template_body_simples",
    "language": {
      "code": "pt_BR"
    },
    "components": [
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "Joao Silva"
          }
        ]
      }
    ]
  }
}
'
{
  "success": true,
  "conversationId": "7a7806cd-597d-49f8-b6a1-c27a47e724f7"
}

Authorizations

x-morada-api-key
string
header
required

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

Body

application/json

Suporta dois formatos: moderno (com template) e legado (com messageTemplate + replacements).

name
string
required

Nome do contato

phoneNumber
string
required

Numero de telefone do contato

instanceId
integer
required

ID da instancia do bot WhatsApp

source
string
required

Origem da notificacao

email
string<email>

Email do contato (opcional)

ignoreTransferToTalkIfUnanswered
boolean

Se true, nao transfere para o Talk caso o lead nao responda

specialInstructions
string

Instrucoes especiais para a MIA ao responder o lead

template
object

Estrutura do template WhatsApp seguindo o padrao da Meta Cloud API

messageTemplate
string

Nome do template de mensagem (formato legado)

replacements
string[]

Substituicoes para os placeholders do template (formato legado)

Response

Notificacao enviada com sucesso

success
boolean

Indica se a notificacao foi enviada com sucesso

conversationId
string<uuid>

ID da conversa criada ou localizada