Skip to main content
PATCH
Atualizar cliente
Atualiza os dados de um cliente existente. Envie apenas os campos que deseja alterar.

Autorizações

Authorization
string
header
obrigatório

Token JWT obtido via /v1/auth/token

Parâmetros de caminho

id
string<uuid>
obrigatório

ID do cliente

Exemplo:

"550e8400-e29b-41d4-a716-446655440000"

Corpo

application/json
name
string | null

Nome do cliente

Exemplo:

"Joao Silva Santos"

email
string | null

E-mail do cliente

Exemplo:

"joao.santos@email.com"

document
string | null

CPF ou CNPJ

Exemplo:

"12345678900"

documentType
enum<string> | null

Tipo do documento

Opções disponíveis:
CPF,
CNPJ
Exemplo:

"CPF"

phone
string | null

Telefone com codigo do pais. Aceita com ou sem '+' no envio e e salvo apenas com digitos.

Exemplo:

"5511999997777"

status
enum<string> | null

Status do cliente

Opções disponíveis:
Active,
Inactive
Exemplo:

"Active"

metadata
string | null

Metadados em JSON

Exemplo:

null

Resposta

Cliente atualizado

data
object | null
message
string | null
error
object | null