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.

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
name
string
required

Nome.

Example:

"Ana Lima"

clientIds
string
required

com ao menos um uuid de cliente

Example:
sem
string
required

repetir

Example:

"exemplo"

code
string

Opcional no corpo.

Example:

"exemplo"

description
string

Texto descritivo.

Example:

"Detalhe da integração"

status
string

Opcional no corpo.

Example:

"exemplo"

autoRenewal
string

Opcional no corpo.

Example:

"exemplo"

currency
string

BRL, USD, EUR ou GBP.

Example:

"BRL"

notes
string

Observação.

Example:

"Detalhe da integração"

scopes
string

PROJECT, HELPDESK ou ATTENDANCE

Example:

"exemplo"

businessHours
string

Opcional no corpo.

Example:

"exemplo"

rules
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"