Skip to main content
PATCH
Atualizar cliente
Updates an existing customer. All fields are optional only provide the fields you want to change.

Authorizations

Authorization
string
header
required

Token JWT obtido via /v1/auth/token

Path Parameters

id
string<uuid>
required

ID do cliente

Example:

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

Body

application/json
name
string | null

Nome do cliente

Example:

"Joao Silva Santos"

email
string | null

E-mail do cliente

Example:

"joao.santos@email.com"

document
string | null

CPF ou CNPJ

Example:

"12345678900"

documentType
enum<string> | null

Tipo do documento

Available options:
CPF,
CNPJ
Example:

"CPF"

phone
string | null

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

Example:

"5511999997777"

status
enum<string> | null

Status do cliente

Available options:
Active,
Inactive
Example:

"Active"

metadata
string | null

Metadados em JSON

Example:

null

Response

Cliente atualizado

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