Skip to main content
POST
Criar 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 do cliente

Maximum string length: 191
document_type
enum<integer>
required

1 = CPF, 2 = CNPJ

Available options:
1,
2
customer_type
enum<integer>
required

1 = Matriz, 2 = Filial

Available options:
1,
2
company_name
string

Razão social do cliente

Maximum string length: 100
document
string

Documento do cliente (CPF ou CNPJ, conforme document_type)

Maximum string length: 40
main_activity
string

Atividade principal do cliente

Maximum string length: 255
email
string<email>

E-mail do cliente

Maximum string length: 254
phone
string

Telefone do cliente

Maximum string length: 30
address
string

Endereço do cliente

Maximum string length: 255
description
string

Descrição do cliente

Maximum string length: 255
status
boolean

Indica se o cliente está ativo

parent_id
string<uuid>

ID do cliente matriz. Obrigatório quando customer_type = 2 e proibido quando customer_type = 1

contacts
object

Contatos vinculados ao cliente. Envie to_add (contatos a vincular) e to_rem (contatos a desvincular).

tags
object

Etiquetas do cliente. Envie to_add (etiquetas a adicionar) e to_rem (etiquetas a remover).

form_answers
object[]

Respostas do formulário dinâmico

Response

Sucesso (CNPJ)