Skip to main content
POST
Cria uma regra ligada a um contrato. O critério precisa pertencer ao pilar escolhido.
Autenticação: Authorization: Bearer SEU_JWT.

Obrigatório

companyId, userId, agreementId, scope, conditions, responseTimeMinutes, resolutionTimeMinutes.

Campos

Exemplo mínimo

Exemplo completo

Exemplo de resposta

Resposta

Sucesso: success é true, code é SUCCESS e o conteúdo vem em data. Falha de regra traz message, status e code. Falha de validação traz error. O índice está em Erros e códigos.

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.

Path Parameters

companyId
string
required

Empresa da sessão.

Example:

"UUID_DA_EMPRESA"

userId
string
required

Usuário da sessão.

Example:

"UUID_DO_USUARIO"

Body

application/json
agreementId
string
required

Obrigatório no corpo.

Example:

"1"

scope
string
required

PROJECT, HELPDESK ou ATTENDANCE

Example:

"exemplo"

conditions
string
required

com ao menos um item

Example:

"exemplo"

responseTimeMinutes
string
required

Obrigatório no corpo.

Example:

"exemplo"

resolutionTimeMinutes
string
required

Obrigatório no corpo.

Example:

"exemplo"

matchMode
string

Opcional no corpo.

Example:

"exemplo"

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"