Skip to main content
PATCH
Atualizar cliente
PATCH /customers/:id Faz parte do recurso Clientes — o objeto e o que o torna único estão lá. Todos os campos são opcionais: só o que você envia muda, o resto fica como está. A resposta traz o cliente já atualizado, e o updatedAt é sempre reescrito, mesmo que nenhum valor tenha mudado de fato.
Apesar do verbo, o corpo é parcial. Enviar { "phone": "..." } altera só o telefone — nome, e-mail e documento continuam intactos. Não existe forma de limpar um campo obrigatório: mandar null em name, email, document, documentType, phone ou type responde 400.
O endereço é substituído por inteiro, não mesclado. O objeto address exige as oito chaves — enviar { "address": { "city": "Rio de Janeiro" } } responde 400, e não uma atualização só da cidade. Para mudar uma linha do endereço, envie o bloco completo com os demais valores repetidos; as chaves que você não souber vão como null.Omitir address é diferente de enviá-lo: omitido, o endereço atual é preservado.
Documento e e-mail continuam únicos na atualização. Apontar para um valor que já pertence a outro cliente da sua conta responde 409, não 400 — é conflito com um cadastro existente. O formato do erro está em Erros.

Exemplo

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Headers

Idempotency-Key
string

Chave única para garantir idempotência da requisição

Path Parameters

id
string
required

ID do cliente

Body

application/json
name
string
Minimum string length: 2
email
string<email>
type
enum<string>
Available options:
individual,
company
document
string
Minimum string length: 6
documentType
enum<string>

Tipo do documento: cpf, cnpj ou passport. Obrigatório quando type é company; em individual, omitir assume cpf.

Available options:
cpf,
cnpj,
passport
phone
string
Minimum string length: 1
address
object

Response

Cliente atualizado

id
string

Identificador único do registro.

name
string

Nome do registro.

email
string

E-mail de contato.

type
string

Tipo de lançamento (sale, refund, chargeback, withdrawal, fee, etc)

document
string

Documento (CPF ou CNPJ) do titular.

documentType
string

Tipo de documento: cpf ou cnpj.

phone
string

Telefone de contato.

address
object | null

Endereço do cliente.

createdAt
string<date-time>

Data e hora de criação do registro (ISO 8601).

updatedAt
string<date-time>

Data e hora da última atualização do registro (ISO 8601).