Skip to main content

​
Visão geral

Este endpoint permite atualizar parcialmente os dados de um cliente já cadastrado. Apenas os campos enviados no corpo da requisição serão alterados.

​
Endpoint

curl --request PATCH \
  --url https://api.avanttifinance.com/v1/customers/{customer_id} \
  --header "Authorization: Bearer SEU_TOKEN_DE_ACESSO" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "Maria da Silva Santos",
    "email": "maria.santos@exemplo.com"
  }'

​
Parâmetros de path

​
customer_id
string
required
Identificador único do cliente a ser atualizado.

​
Parâmetros do corpo

​
name
string
Novo nome completo do cliente.
​
email
string
Novo e-mail do cliente.
​
phone
string
Novo número de telefone, no formato +55DDDXXXXXXXXX.
​
metadata
object
Objeto livre para armazenar informações adicionais relevantes para o seu negócio.

​
Resposta

Retorna o objeto do cliente com os dados atualizados. 
{
  "id": "cus_3a8f9c1b2d",
  "name": "Maria da Silva Santos",
  "email": "maria.santos@exemplo.com",
  "document": "123.456.789-00",
  "updated_at": "2026-06-11T10:00:00Z"
}
Alterar o e-mail de um cliente não invalida transações já realizadas, mas pode afetar o envio de notificações futuras.

​
Erros comuns

Código HTTPSignificado
400Dados inválidos no corpo da requisição
401Token de autenticação inválido ou ausente
404Cliente não encontrado

​
Próximos passos

Listar clientes

Consulte todos os clientes cadastrados.

Deletar cliente

Remova um cliente da sua base.