Skip to main content
POST
Cadastrar um cliente

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required

Nome completo do cliente.

Required string length: 1 - 160
document
string
required

CPF ou CNPJ do cliente, com ou sem máscara. O tipo é deduzido do número.

Minimum string length: 11
email
string<email>

E-mail principal do cliente.

phone
string

Telefone do cliente, com DDI e DDD.

Minimum string length: 8
instagram
string

Perfil do Instagram do cliente.

Maximum string length: 60
birthDate
string<date-time>

Data de nascimento (ISO 8601).

mailMarketing
boolean

Marque true quando o cliente aceitou receber marketing.

taxFree
boolean

Marque true quando o cliente é isento de imposto.

tags
string[]

Etiquetas livres para segmentar o cliente.

Maximum array length: 20
Minimum string length: 1
notes
string

Anotações internas sobre o cliente.

Maximum string length: 1000
address
object

Endereço de entrega do cliente.

Response

Cliente criado, ou o que já existia com o mesmo documento.

Cliente criado, ou o que já existia com o mesmo documento.

success
boolean
required

Sempre true em uma resposta bem-sucedida.

data
object
required