Criar lead inbound (contato + empresa + negócio)

POST

/api/v1/leads

Cria, numa única chamada, o contato (obrigatório: name + email ou phone; deduplicado por e-mail/telefone), a empresa (opcional — criada se vier company.name OU company.cnpj; na falta de name o CNPJ vira o nome; deduplicada por CNPJ/domínio) e o negócio (obrigatório: title + pipelineId + stageId válidos do workspace), linkando tudo. Cria só o que for informado. Envie idempotencyKey para reenvios não duplicarem o negócio.

Request

Body Params application/jsonRequired

Examples

Responses

🟢201Created

Lead criado: { contactId, companyId, dealId, contactCreated, companyCreated, dealCreated }. companyId é null se nenhuma empresa foi informada. Reenvio com a mesma idempotencyKey devolve o mesmo negócio com os *Created=false.

This response does not have a body.

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v1/leads' \
--header 'Content-Type: application/json' \
--data-raw '{
    "contact": {
        "name": "string",
        "email": "user@example.com",
        "phone": "string",
        "phoneType": "string",
        "role": "string",
        "location": "string",
        "tags": [
            "string"
        ],
        "customFields": {},
        "ownerId": "string"
    },
    "deal": {
        "title": "string",
        "pipelineId": "string",
        "stageId": "string",
        "value": 0,
        "notes": "string",
        "customFields": {},
        "ownerId": "string"
    },
    "company": {
        "name": "string",
        "cnpj": "string",
        "website": "string",
        "industry": "string",
        "size": "string",
        "location": "string",
        "customFields": {},
        "ownerId": "string"
    },
    "idempotencyKey": "string"
}'

Modified at 2026-06-22 20:05:40

Marcar passo como já conectado

ContactEntity