Skip to main content
PUT
/
api
/
v1
/
functions
/
{id}
Atualizar Função
curl --request PUT \
  --url https://chat.api.toolzz.com.br/api/v1/functions/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "code": "<string>",
  "userId": "<string>",
  "unityId": "<string>",
  "outputs": [
    {
      "required": true,
      "id": {},
      "type": "<string>",
      "description": "<string>",
      "property": "<string>"
    }
  ],
  "iconFile": "<string>"
}
'
{
  "id": "<string>",
  "institutionId": "<string>",
  "userId": "<string>",
  "unityId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "code": "<string>",
  "status": true,
  "isActivated": true,
  "color": "<string>",
  "iconFileId": "<string>",
  "pluginIcon": {
    "url": "<string>",
    "fileName": "<string>",
    "extension": "<string>",
    "size": 123
  },
  "outputs": [
    {
      "property": "<string>",
      "type": "<string>",
      "description": "<string>",
      "required": true
    }
  ]
}

​
Token de Acesso

​
Authorization
string
Token de acesso (“Bearer” deve estar antes do token)

​
Corpo da Requisição

​
id
string
required
ID da Função
​
name
string
required
Nome da função (ex: onboardingAI)
​
description
string
required
Descrição da função
​
code
string
required
Código JavaScript da função assíncrona
​
userId
string
required
ID do usuário proprietário
​
unityId
string
required
ID da unidade (Unity)
​
outputs
array
required
Configurações de saída da função.
​
iconFile
string
URL da imagem do ícone.

​
Descrição da Resposta

Abaixo você verá a descrição da resposta da atualização da função
​
id
string
required
Identificador único universal (UUID) da função.
​
institutionId
string
required
Identificador da instituição à qual esta função pertence.
​
userId
string
required
ID do usuário.
​
unityId
string
required
Identificador da unidade.
​
name
string
required
Nome identificador da função (ex: onboardinAI).
​
description
string
required
Descrição da função.
​
code
string
required
O corpo do código JavaScript que será executado pela função.
​
status
boolean
required
Indica se a função está disponível para uso (true) ou desabilitada (false).
​
isActivated
boolean
required
Define se a integração está ativa e pronta para receber requisições de gatilho.
​
color
string
required
Código ou nome da cor (ex: red) utilizada para rotular a função na interface do usuário.
​
iconFileId
string
Referência única para o arquivo de imagem armazenado que serve como ícone.
​
pluginIcon
object
Objeto contendo metadados do arquivo de imagem.
​
outputs
array
Lista de parâmetros que a função retorna ou exige como mapeamento.

​
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.