---
title: "Criar Deal"
method: POST
path: "/{partnerId}/deal"
tags: ["Deals"]
---

# Criar Deal

`POST /{partnerId}/deal`

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

## Path parameters

- `partnerId` string, required

## Request body

- CreateDealRequest
  - `name` string, required — Nome completo do lead
  - `phoneNumber` union, required — Telefone valido do lead com DDD. DDI e opcional (assume 55 se ausente).
    - string
    - number
  - `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, required — Origem do lead (ex: Website, Facebook, Simulador)
  - `messageTemplate` string — Template de mensagem WhatsApp para iniciar conversa com a MIA
  - `replacements` string[] — Substituicoes para os placeholders do template
  - `instanceId` union — ID da instancia do bot
    - string
    - number
  - `externalId` union — ID externo do deal
    - string
    - number
  - `variantId` string — ID da variante
  - `extras` union — Dados extras que podem ser usados em integracoes. Pode ser um objeto JSON ou uma JSON string.
    - object
    - string
  - `specialInstructions` string — Instrucoes especiais para a MIA durante a conversa

## Response `200`

Deal criado ou atualizado com sucesso

- CreateDealResponse
  - `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)

## Other responses

- `400` — Requisicao invalida - erro de validacao
- `500` — Erro interno do servidor

---

[API](https://skmtc.dev/morada/apis/api-morada-ai.md) · [All operations](https://skmtc.dev/morada/apis/api-morada-ai/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/morada/api-morada-ai/revisions/9ce869fc8130/schema)