Pular para o conteúdo principal
PATCH
/
v1
/
customers
/
{id}
Atualizar cliente
curl --request PATCH \
  --url https://api-payment.safefypay.com.br/v1/customers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Joao Silva Santos",
  "phone": "11999997777"
}
'
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "externalId": "cliente_123",
    "name": "Joao Silva Santos",
    "email": "[email protected]",
    "document": "123.456.789-00",
    "documentType": "CPF",
    "phone": "11999997777",
    "status": "Active",
    "metadata": null,
    "address": null,
    "createdAt": "2025-01-15T15:00:00Z"
  },
  "message": "Cliente atualizado com sucesso.",
  "error": null
}
Atualiza os dados de um cliente existente. Envie apenas os campos que deseja alterar.

​
Parametros de Path

​
id
string
obrigatório
ID do cliente (UUID).

​
Parametros de Body

Todos os campos sao opcionais. Envie apenas os que deseja atualizar.
​
name
string
Nome completo do cliente.
​
email
string
Endereco de email do cliente.
​
document
string
Numero do documento (CPF ou CNPJ).
​
documentType
string
Tipo do documento: CPF ou CNPJ.
​
phone
string
Telefone no formato internacional.
​
status
string
Status do cliente: Active ou Inactive.
​
metadata
string
Dados adicionais em formato JSON string.

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:

"[email protected]"

​
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

Exemplo:

"11999997777"

​
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
​
message
string | null
​
error
object