MOmorada
Deals

Criar Deal

Changed on

Cria um novo deal na plataforma e opcionalmente inicia uma conversa no WhatsApp via template de mensagem.

post/{partnerId}/deal

Request

  • Base URL
    https://mia-gateway.morada.ai
  • URL
    https://mia-gateway.morada.ai/{partnerId}/deal
  • Auth
    API key in header x-morada-api-key

Path parameters

partnerIdstring required

ID do parceiro

Request body

namestring required

Nome completo do lead

emailstring email

Email valido do lead

productIdstring

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

productExternalIdstring

ID externo do produto no CRM ou plataforma do cliente

partnerIdstring

ID do parceiro (caso nao venha pelo path)

conversionIdentifierstring

Identificador da conversao para rastreamento

bypassProductCheckboolean

Pular validacao de produto

sourcestring

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

campaignstring

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

mediumstring

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

messageTemplatestring

Template de mensagem WhatsApp para iniciar conversa com a MIA

replacementsstring[]

Substituicoes para os placeholders do template

variantIdstring

ID da variante

specialInstructionsstring

Instrucoes especiais para a MIA durante a conversa

Response

Deal criado ou atualizado com sucesso

dealIdstring

Identificador unico do deal criado

messagestring

Mensagem descritiva do resultado da operacao

conversationIdstring

ID da conversa (quando ja existia uma conversa aberta)

skippedboolean

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

Changes

  • c0c07db5ee7dRevision changes
    • warning

      the request property's maxLength was set to 255

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became optional