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:

ObjetoCampoDescriçãotipolimitação de caracteresObrigatório
nameNome completo do cliente.string255Sim
surnameApelido do cliente, deve ser único no sistema. Ex.: 'joao.silva'
Não é permitido usar o mesmo apelido para outro cliente.
string255Sim
documentNúmero do documento (CPF ou CNPJ). Somente número.string11 ou 14 caracteres sem máscaraSim
emailsLista de e-mails do cliente.arrayarray de strings com 255 caracteres cadaSim
phonesLista de telefones do cliente.arrayarray de strings com 255 caracteres cadaSim
addressEndereço do cliente (veja campos abaixo).arraySim
address.cepCEP (apenas números)string8 caracteres sem máscaraSim
address.streetNome da rua/avenidastring255Sim
address.numberNúmero do endereçostring15, apenas dígitos ou “S/N”Sim
address.stateUF (ex: "SP").string2 caracteresSim
address.cityNome da cidadestring255Sim
externalCustomerIdIdentificador de controle interno do tenant.string255Sim

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:

ObjetoCampoDescriçãotipo
nameNome completo do cliente.string
surnameApelido do cliente, deve ser único no sistema. Ex.: 'joao.silva'
Não é permitido usar o mesmo apelido para outro cliente.
string
documentNúmero do documento (CPF ou CNPJ). Somente número.string
emailsLista de e-mails do cliente.array
phonesLista de telefones do cliente.array
addressEndereço do cliente (veja campos abaixo).array
address.cepCEP (apenas números)string
address.streetNome da rua/avenidastring
address.numberNúmero do endereçostring
address.stateUF (ex: "SP").string
address.cityNome da cidadestring
externalCustomerIdIdentificador de controle interno do tenant.string