Skip to main content
POST

Authorizations

Authorization
string
header
required

Todas as requisições devem incluir o JWT da conta no header Authorization no formato Bearer. Sem esse header a requisição é recusada.

Query Parameters

workspaceId
string
required

Funil que recebe o lead.

Example:

"ID_DO_FUNIL"

Body

application/json
companyId
string
required

Empresa da sessão.

Example:

"UUID_DA_EMPRESA"

userId
string
required

Usuário da sessão.

Example:

"UUID_DO_USUARIO"

contact
object
required

Contato. name é obrigatório.

Example:
title
string

Título do lead.

Example:

"Interesse no plano anual"

notes
string

Observação.

Example:

"Detalhe da integração"

source
string

Origem da conversa.

Example:

"exemplo"

columnId
string

Coluna em que o lead nasce.

Example:

"ID_DA_COLUNA"

value
integer

Valor, inteiro maior ou igual a 0.

Example:

0

currency
string

BRL, USD, EUR ou GBP.

Example:

"BRL"

tags
string[]

Etiquetas do lead.

Example:
responsibleId
string

UUID de um usuário da empresa.

Example:

"UUID_DO_RESPONSAVEL"

stage
string

won, lost ou delete.

Example:

"won"

reason
string

Opcional no corpo.

Example:

"exemplo"

categoryReasonId
string

Opcional no corpo.

Example:

"1"

products
object[]

Nome, quantidade e preço.

Example:

Response

A operação concluiu. success é true, code é SUCCESS e o conteúdo vem em data.

success
boolean
required
Example:

true

data
any
required

Conteúdo da operação. O exemplo 200 de cada rota preenche os campos do recurso.

code
string
required
Example:

"SUCCESS"