Skip to main content
POST
/
customers
/
create
curl -X POST 'https://api.goatpay.com.br/v1/customers/create' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Maria Silva",
    "email": "maria@email.com",
    "document": "12345678901",
    "type": "PF",
    "status": "Ativo",
    "phone": "11999999999",
    "city": "São Paulo",
    "state": "SP"
  }'

{
  "success": true,
  "message": "Cliente criado",
  "data": {
    "id": "clx_customer",
    "name": "Maria Silva",
    "email": "maria@email.com",
    "document": "123.456.789-01",
    "type": "PF",
    "status": "Ativo",
    "phone": "11999999999",
    "whatsapp": "",
    "city": "São Paulo",
    "state": "SP",
    "transactions": 0,
    "volume": 0,
    "createdAt": "2026-06-02T12:00:00.000Z",
    "lastActivityAt": "2026-06-02T12:00:00.000Z"
  },
  "requestId": "req_abc"
}
URL: POST https://api.goatpay.com.br/v1/customers/create · Permissão: customers/create
curl -X POST 'https://api.goatpay.com.br/v1/customers/create' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Maria Silva",
    "email": "maria@email.com",
    "document": "12345678901",
    "type": "PF",
    "status": "Ativo",
    "phone": "11999999999",
    "city": "São Paulo",
    "state": "SP"
  }'

{
  "success": true,
  "message": "Cliente criado",
  "data": {
    "id": "clx_customer",
    "name": "Maria Silva",
    "email": "maria@email.com",
    "document": "123.456.789-01",
    "type": "PF",
    "status": "Ativo",
    "phone": "11999999999",
    "whatsapp": "",
    "city": "São Paulo",
    "state": "SP",
    "transactions": 0,
    "volume": 0,
    "createdAt": "2026-06-02T12:00:00.000Z",
    "lastActivityAt": "2026-06-02T12:00:00.000Z"
  },
  "requestId": "req_abc"
}

​
Corpo da requisição

​
name
string
required
Nome (1–200 caracteres).
​
email
string
required
E-mail válido.
​
document
string
required
CPF (11 dígitos) ou CNPJ (14), somente números.
​
type
string
PF ou PJ (padrão inferido pelo documento).
​
status
string
Ativo, Inativo, Bloqueado ou active / inactive / blocked.
​
phone
string
Telefone.
​
whatsapp
string
WhatsApp.
​
city
string
Cidade.
​
state
string
UF (2 letras).
Guia: Clientes · Visão da loja: Loja.

Authorizations

​
X-API-Key
string
header
required

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

Body

application/json
​
name
string
required
Maximum string length: 200
​
email
string<email>
required
​
document
string
required

CPF (11 dígitos) ou CNPJ (14), somente números.

Pattern: ^(\d{11}|\d{14})$
​
type
enum<string>
Available options:
PF,
PJ,
pf,
pj
​
status
string

Ativo, Inativo, Bloqueado ou active/inactive/blocked

​
phone
string
Maximum string length: 20
​
whatsapp
string
Maximum string length: 20
​
city
string
Maximum string length: 120
​
state
string
Maximum string length: 2

Response

Cliente criado, consultado ou atualizado.

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