Atualizar cliente

PUT

/partner/v1/lead

Atualização PARCIAL: o que não vier no corpo fica como está. O cliente é identificado pelo partner_code, que não é alterável.

Trocar o WhatsApp por um número que já pertence a outro cliente seu é recusado com PARTNER_LEAD_WHATSAPP_ALREADY_EXISTS, e a resposta traz o partner_code de quem já tem o número.

O que esta rota NÃO altera: a origem do cliente, o estado de atendimento e o corretor responsável (que tem rota própria).

Duas alterações SIMULTÂNEAS no mesmo cliente não se combinam campo a campo: a última a gravar vence. Serialize as suas chamadas por cliente.

null é recusado em qualquer campo. String vazia ("") apaga em rg, profession e marital_status, é ignorada em address_state, address_city e notes, e é recusada nos demais.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Example

{
    "segment": "Investidor",
    "message_consent": "GRANTED",
    "status": 1,
    "document_type": "cpf",
    "birth_date": "1985-03-14",
    "partner_code": "CLI-8842",
    "name": "Ana Pereira Souza",
    "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": "Casado"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT '/partner/v1/lead' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "segment": "Investidor",
    "message_consent": "GRANTED",
    "status": 1,
    "document_type": "cpf",
    "birth_date": "1985-03-14",
    "partner_code": "CLI-8842",
    "name": "Ana Pereira Souza",
    "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": "Casado"
}'

Responses

🟢200

application/json

Cliente atualizado.

Bodyapplication/json

Example

{
    "partner_code": "AP-1024",
    "lead_id": 900
}

🟠400

🟠401

🟠403

🟠404

🟠429

🔴500

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

Cadastrar cliente

Cadastrar clientes em lote