Skip to main content
POST

Authorizations

Authorization
string
header
required

Chave de integração com prefixo wegly_, enviada em Authorization: Bearer . Não é JWT. A chave deve estar ativa, não excluída e dentro da validade. Com allowed_domain, Origin (ou Referer na ausência de Origin) precisa informar o hostname permitido. A empresa e as permissões são obtidas pela chave.

Body

application/json
target_type
enum<string>
required

Tipo de registro do critério: LEAD (leads), DEAL (oportunidades) ou BOTH (os dois).

Available options:
LEAD,
DEAL,
BOTH
name
string
required

Espaços das extremidades são removidos.

Required string length: 1 - 120
points
integer
required

Inteiro entre -100 e 100, diferente de 0. Obrigatório mesmo com opções: vale quando o critério não tem opções ativas.

Required range: -100 <= x <= 100
category_id
string<uuid> | null

Categoria ativa da empresa. null ou omitido: critério sem categoria.

description
string | null
Maximum string length: 5000
options
object[]

Opções de resposta. Com opções ativas, quem aplica o critério escolhe uma, e a pontuação aplicada é a da opção.

Maximum array length: 50

Response

Critério criado.

id
string<uuid>
required
category_id
string<uuid> | null
required
category
object | null
required
target_type
enum<string>
required

Tipo de registro do critério: LEAD (leads), DEAL (oportunidades) ou BOTH (os dois).

Available options:
LEAD,
DEAL,
BOTH
name
string
required
Maximum string length: 120
description
string | null
required
points
integer
required

Pontos do critério; valem quando ele não tem opções ativas.

Required range: -100 <= x <= 100
status
enum<integer>
required

Situação do critério ou da opção: 0 = inativo, 1 = ativo.

Available options:
0,
1
options
object[]
required

Opções não removidas (ativas e inativas), ordenadas por position. Vazio quando não há.

created_at
string<date-time>
required
updated_at
string<date-time>
required