Skip to main content
PATCH
/
customers
/
update
/
{id}
curl -X PATCH 'https://api.goatpay.com.br/v1/customers/update/clx_customer' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": "Inativo",
    "phone": "11988887777"
  }'

{
  "success": true,
  "message": "Cliente atualizado",
  "data": {
    "id": "clx_customer",
    "name": "Maria Silva",
    "status": "Inativo",
    "phone": "11988887777"
  },
  "requestId": "req_abc"
}
URL: PATCH https://api.goatpay.com.br/v1/customers/update/{id} · Permissão: customers/update
curl -X PATCH 'https://api.goatpay.com.br/v1/customers/update/clx_customer' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": "Inativo",
    "phone": "11988887777"
  }'

{
  "success": true,
  "message": "Cliente atualizado",
  "data": {
    "id": "clx_customer",
    "name": "Maria Silva",
    "status": "Inativo",
    "phone": "11988887777"
  },
  "requestId": "req_abc"
}

​
Parâmetros e corpo

​
id
string
required
ID do cliente.
Envie apenas os campos que deseja alterar (name, email, document, type, status, phone, whatsapp, city, state). Mesmas regras de criar cliente. Guia: Clientes.

Authorizations

​
X-API-Key
string
header
required

Chave gp_live_... criada em Integrações → Chaves de API no dashboard.

Path Parameters

​
id
string
required

ID do recurso (transação, cobrança, webhook, etc.)

Body

application/json
​
name
string
​
email
string<email>
​
document
string
​
type
enum<string>
Available options:
PF,
PJ,
pf,
pj
​
status
string
​
phone
string
​
whatsapp
string
​
city
string
​
state
string

Response

200 - application/json

Cliente criado, consultado ou atualizado.

​
success
boolean
required
​
message
string
required
​
data
object
required
​
requestId
string