Pular para o conteúdo principal
cURL
Envie somente os campos que deseja modificar. Preserve o identificador usado nos vínculos da sua aplicação.

Autorizações

Authorization
string
header
obrigatório

Chave secreta sk_live_ da empresa. Use somente no servidor.

Parâmetros de caminho

id
string<uuid>
obrigatório

Corpo

Cliente da sua empresa. Expõe apenas os dados principais de cadastro e um único documento principal (CPF ou CNPJ).

name
string
Maximum string length: 255
email
string<email>
Maximum string length: 254
phone
string

Telefone do cliente com DDD (opcional no cadastro).

Maximum string length: 255
document
string | null

Documento principal do cliente: CPF ou CNPJ, somente dígitos ou formatado.

type
enum<string>

Tipo do documento principal: pf para CPF ou pj para CNPJ.

Opções disponíveis:
pf,
pj
address
string | null

Endereço em linha livre, opcional.

notes
string | null

Observações internas sobre o cliente, opcionais.

Maximum string length: 500

Resposta

200 - application/json

Cliente da sua empresa. Expõe apenas os dados principais de cadastro e um único documento principal (CPF ou CNPJ).

id
string<uuid>
obrigatório
read-only
name
string
obrigatório
Maximum string length: 255
email
string<email>
obrigatório
Maximum string length: 254
createdAt
string<date-time>
obrigatório
read-only
archivedAt
string<date-time>
obrigatório
read-only
anonymizedAt
string<date-time>
obrigatório
read-only
phone
string

Telefone do cliente com DDD (opcional no cadastro).

Maximum string length: 255
document
string | null

Documento principal do cliente: CPF ou CNPJ, somente dígitos ou formatado.

type
enum<string>

Tipo do documento principal: pf para CPF ou pj para CNPJ.

Opções disponíveis:
pf,
pj
address
string | null

Endereço em linha livre, opcional.

notes
string | null

Observações internas sobre o cliente, opcionais.

Maximum string length: 500