Cadastrar clientes em lote

POST

/partner/v1/lead/batch

Até 200 clientes por chamada, respeitado o teto de 5 MB de corpo. A resposta separa created de skipped, então a carga inteira pode ser reenviada após uma falha sem duplicar nada — lembrando que skipped NÃO atualiza o que já existe.

Os itens são gravados em série, um por vez: a dedupe por WhatsApp é uma leitura seguida de escrita, e paralelizar só aumentaria a chance de dois clientes iguais passarem pela mesma janela. Uma carga cheia leva alguns segundos.

A resposta 201 pode conter falha: um item pode falhar sozinho e os demais serem criados.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "leads": [
        {
            "segment": "Investidor",
            "message_consent": "GRANTED",
            "document_type": "cpf",
            "birth_date": "1985-03-14",
            "partner_code": "CLI-8842",
            "name": "Ana Pereira",
            "whatsapp": "(48) 99999-1234",
            "email": "ana@exemplo.com",
            "phone": "(48) 3333-2222",
            "address_state": "SC",
            "address_city": "Florianópolis",
            "notes": "Procura 2 dormitórios até R$ 500 mil.",
            "document": "123.456.789-00",
            "rg": "12.345.678-9",
            "profession": "Médica",
            "marital_status": "Solteiro"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/partner/v1/lead/batch' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "leads": [
        {
            "segment": "Investidor",
            "message_consent": "GRANTED",
            "document_type": "cpf",
            "birth_date": "1985-03-14",
            "partner_code": "CLI-8842",
            "name": "Ana Pereira",
            "whatsapp": "(48) 99999-1234",
            "email": "ana@exemplo.com",
            "phone": "(48) 3333-2222",
            "address_state": "SC",
            "address_city": "Florianópolis",
            "notes": "Procura 2 dormitórios até R$ 500 mil.",
            "document": "123.456.789-00",
            "rg": "12.345.678-9",
            "profession": "Médica",
            "marital_status": "Solteiro"
        }
    ]
}'

Responses

🟢201

application/json

Resultado por item: criados, já existentes e erros.

Bodyapplication/json

Example

{
    "created": [
        {
            "partner_code": "AP-1024",
            "lead_id": 900
        }
    ],
    "skipped": [
        {
            "partner_code": "AP-1024",
            "lead_id": 900
        }
    ],
    "errors": [
        {
            "partner_code": "AP-1024",
            "errorCode": "PARTNER_PROPERTY_NOT_FOUND",
            "errorMessage": "string",
            "conflict_partner_code": "string"
        }
    ]
}

🟠400

🟠401

🟠403

🟠429

🔴500

Modified at 2026-08-20 16:06:11

Atualizar cliente

Consultar detalhes do cliente