POST
/
api
/
v1
/
functions
/
Criar Função
curl --request POST \
  --url https://chat.api.toolzz.com.br/api/v1/functions/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "userId": "<string>",
  "unityId": "<string>",
  "outputs": [
    {}
  ]
}'
{
  "id": "<string>",
  "institutionId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "code": "<string>",
  "status": true,
  "unityId": "<string>",
  "userId": "<string>",
  "iconFileId": "<string>",
  "color": "<string>",
  "outputs": [
    {}
  ],
  "isActivated": true
}

​
Corpo da Requisição

​
name
string
required
Nome da função
​
description
string
required
Descrição da função
​
userId
string
required
ID do usuário
​
unityId
string
required
ID da unidade
​
outputs
array
required
Array de outputs

​
Descrição da Resposta

Abaixo você verá a descrição da resposta da criação da função
​
id
string
required
Identificador único do plugin.
​
institutionId
string
required
ID da instituição associada.
​
name
string
required
Nome do plugin.
​
description
string
required
Descrição da funcionalidade do plugin.
​
code
string
required
Código JavaScript que define a funcionalidade do plugin.
​
status
boolean
required
Indica se o plugin está habilitado.
​
unityId
string
required
ID da unidade associada.
​
userId
string
required
ID do usuário que criou ou gerencia o plugin.
​
iconFileId
string
ID opcional do arquivo de ícone do plugin.
​
color
string
required
Cor associada ao plugin para fins de UI.
​
outputs
array
Lista de outputs do plugin (vazio se não existirem).
​
isActivated
boolean
required
Indica se o plugin está ativado.

​
Segurança

Para acessar este endpoint, é necessário enviar um token de acesso válido através do cabeçalho de autorização (Authorization) da requisição. Além disso, a API é protegida por outras medidas de segurança para proteger os dados dos usuários.