Atualizar cliente

Para atualizar os dados de um cliente já cadastrado, é necessário ter um token válido e utilizar o endpoint Atualizar cliente.


Modelo de Requisição:

Request

{
    "version": "1.0.0",
    "body": {
        "id": "6a0e26073b3deb1e41926265",
        "name": "Joãaaaaao",
        "surname": "Silva",
        "document": "15663289003",
        "documentType": "CPF",
        "emails": [
            "[email protected]"
        ],
        "phones": [
            "11999999999"
        ],
        "address": {
            "cep": "01310100",
            "street": "Avenida Paulista",
            "number": "1000",
            "state": "SP",
            "city": "São Paulo",
            "neighborhood": "Bela Vista"
        },
        "externalCustomerId": "ext-customer-4975801-002",
        "createdAt": "2026-05-20T23:21:35.646Z",
        "updatedAt": "2026-05-27T18:35:38.431Z"
    },
    "status": 200
}

Campos da requisição:

Objeto

Campo

Descrição

tipo

limitação de caracteres

Obrigatório

name

Nome completo do cliente.

string

255

Sim

surname

Apelido do cliente, deve ser único no sistema. Ex.: 'joao.silva'
Não é permitido usar o mesmo apelido para outro cliente.

string

255

Sim

document

Número do documento (CPF ou CNPJ). Somente número.

string

11 ou 14 caracteres sem máscara

Sim

emails

Lista de e-mails do cliente.

array

array de strings com 255 caracteres cada

Sim

phones

Lista de telefones do cliente.

array

array de strings com 255 caracteres cada

Sim

address

Endereço do cliente (veja campos abaixo).

array

Sim

address.

cep

CEP (apenas números)

string

8 caracteres sem máscara

Sim

address.

street

Nome da rua/avenida

string

255

Sim

address.

number

Número do endereço

string

15, apenas dígitos ou “S/N”

Sim

address.

state

UF (ex: "SP").

string

2 caracteres

Sim

address.

city

Nome da cidade

string

255

Sim

externalCustomerId

Identificador de controle interno do tenant.

string

255

Sim

Response

{
    "version": "1.0.0",
    "body": {
        "id": "6a0e26073b3deb1e41926265",
        "name": "Joãaaaaao",
        "surname": "Silva",
        "document": "15663289003",
        "documentType": "CPF",
        "emails": [
            "[email protected]"
        ],
        "phones": [
            "11999999999"
        ],
        "address": {
            "cep": "01310100",
            "street": "Avenida Paulista",
            "number": "1000",
            "state": "SP",
            "city": "São Paulo",
            "neighborhood": "Bela Vista"
        },
        "externalCustomerId": "ext-customer-4975801-002",
        "createdAt": "2026-05-20T23:21:35.646Z",
        "updatedAt": "2026-05-27T18:35:38.431Z"
    },
    "status": 200
}

Campos da resposta:

Objeto

Campo

Descrição

tipo

name

Nome completo do cliente.

string

surname

Apelido do cliente, deve ser único no sistema. Ex.: 'joao.silva'
Não é permitido usar o mesmo apelido para outro cliente.

string

document

Número do documento (CPF ou CNPJ). Somente número.

string

emails

Lista de e-mails do cliente.

array

phones

Lista de telefones do cliente.

array

address

Endereço do cliente (veja campos abaixo).

array

address.

cep

CEP (apenas números)

string

address.

street

Nome da rua/avenida

string

address.

number

Número do endereço

string

address.

state

UF (ex: "SP").

string

address.

city

Nome da cidade

string

externalCustomerId

Identificador de controle interno do tenant.

string