Skip to main content
POST
Criar cliente

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

idempotency-key
string
required
Required string length: 1 - 255

Body

application/json
email
string<email>
required

E-mail único na sua base — usado no portal do cliente e nas cobranças recorrentes.

Required string length: 3 - 320
externalId
string

Seu identificador interno do cliente para sincronização com sua base.

Required string length: 1 - 128
name
string

Nome completo do cliente.

Required string length: 1 - 200
phone
string

Telefone do cliente (formato E.164 recomendado).

Required string length: 5 - 32

Response

Default Response

address
object | null
required
archivedAt
string<date-time> | null
required
createdAt
string<date-time>
required
email
string<email>
required
Maximum string length: 320
environment
enum<string>
required
Available options:
live,
test
externalId
string | null
required
Maximum string length: 128
id
string<uuid>
required
name
string | null
required
Maximum string length: 200
phone
string | null
required
Maximum string length: 32
taxId
object | null
required
updatedAt
string<date-time>
required
stats
object