Skip to main content
POST

Corpo da requisição

string
required
Nome (até 200 caracteres).
string
required
E-mail.
string
required
CPF (11) ou CNPJ (14 dígitos).
string
Telefone.
string
PF ou PJ (inferido pelo documento se omitido).

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