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>"
}
'

import requests

url = "https://chat.api.toolzz.com.br/api/v1/functions/{id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "code": "<string>",
    "userId": "<string>",
    "unityId": "<string>",
    "outputs": [
        {
            "required": True,
            "id": {},
            "type": "<string>",
            "description": "<string>",
            "property": "<string>"
        }
    ],
    "iconFile": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    code: '<string>',
    userId: '<string>',
    unityId: '<string>',
    outputs: [
      {
        required: true,
        id: {},
        type: '<string>',
        description: '<string>',
        property: '<string>'
      }
    ],
    iconFile: '<string>'
  })
};

fetch('https://chat.api.toolzz.com.br/api/v1/functions/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://chat.api.toolzz.com.br/api/v1/functions/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'code' => '<string>',
    'userId' => '<string>',
    'unityId' => '<string>',
    'outputs' => [
        [
                'required' => true,
                'id' => [
                                
                ],
                'type' => '<string>',
                'description' => '<string>',
                'property' => '<string>'
        ]
    ],
    'iconFile' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://chat.api.toolzz.com.br/api/v1/functions/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"code\": \"<string>\",\n  \"userId\": \"<string>\",\n  \"unityId\": \"<string>\",\n  \"outputs\": [\n    {\n      \"required\": true,\n      \"id\": {},\n      \"type\": \"<string>\",\n      \"description\": \"<string>\",\n      \"property\": \"<string>\"\n    }\n  ],\n  \"iconFile\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://chat.api.toolzz.com.br/api/v1/functions/{id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"code\": \"<string>\",\n  \"userId\": \"<string>\",\n  \"unityId\": \"<string>\",\n  \"outputs\": [\n    {\n      \"required\": true,\n      \"id\": {},\n      \"type\": \"<string>\",\n      \"description\": \"<string>\",\n      \"property\": \"<string>\"\n    }\n  ],\n  \"iconFile\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://chat.api.toolzz.com.br/api/v1/functions/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"code\": \"<string>\",\n  \"userId\": \"<string>\",\n  \"unityId\": \"<string>\",\n  \"outputs\": [\n    {\n      \"required\": true,\n      \"id\": {},\n      \"type\": \"<string>\",\n      \"description\": \"<string>\",\n      \"property\": \"<string>\"\n    }\n  ],\n  \"iconFile\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "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
    }
  ]
}

PUT

api

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>"
}
'

import requests

url = "https://chat.api.toolzz.com.br/api/v1/functions/{id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "code": "<string>",
    "userId": "<string>",
    "unityId": "<string>",
    "outputs": [
        {
            "required": True,
            "id": {},
            "type": "<string>",
            "description": "<string>",
            "property": "<string>"
        }
    ],
    "iconFile": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    code: '<string>',
    userId: '<string>',
    unityId: '<string>',
    outputs: [
      {
        required: true,
        id: {},
        type: '<string>',
        description: '<string>',
        property: '<string>'
      }
    ],
    iconFile: '<string>'
  })
};

fetch('https://chat.api.toolzz.com.br/api/v1/functions/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://chat.api.toolzz.com.br/api/v1/functions/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'code' => '<string>',
    'userId' => '<string>',
    'unityId' => '<string>',
    'outputs' => [
        [
                'required' => true,
                'id' => [
                                
                ],
                'type' => '<string>',
                'description' => '<string>',
                'property' => '<string>'
        ]
    ],
    'iconFile' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://chat.api.toolzz.com.br/api/v1/functions/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"code\": \"<string>\",\n  \"userId\": \"<string>\",\n  \"unityId\": \"<string>\",\n  \"outputs\": [\n    {\n      \"required\": true,\n      \"id\": {},\n      \"type\": \"<string>\",\n      \"description\": \"<string>\",\n      \"property\": \"<string>\"\n    }\n  ],\n  \"iconFile\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://chat.api.toolzz.com.br/api/v1/functions/{id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"code\": \"<string>\",\n  \"userId\": \"<string>\",\n  \"unityId\": \"<string>\",\n  \"outputs\": [\n    {\n      \"required\": true,\n      \"id\": {},\n      \"type\": \"<string>\",\n      \"description\": \"<string>\",\n      \"property\": \"<string>\"\n    }\n  ],\n  \"iconFile\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://chat.api.toolzz.com.br/api/v1/functions/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"code\": \"<string>\",\n  \"userId\": \"<string>\",\n  \"unityId\": \"<string>\",\n  \"outputs\": [\n    {\n      \"required\": true,\n      \"id\": {},\n      \"type\": \"<string>\",\n      \"description\": \"<string>\",\n      \"property\": \"<string>\"\n    }\n  ],\n  \"iconFile\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

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

string

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

Corpo da Requisição

string

required

ID da Função

string

required

Nome da função (ex: onboardingAI)

string

required

Descrição da função

string

required

Código JavaScript da função assíncrona

string

required

ID do usuário proprietário

string

required

ID da unidade (Unity)

array

required

Configurações de saída da função.

Show Outputs properties

boolean

Indica se o campo é obrigatório.

stringcd

ID único do output.

string

Tipo de dado (ex: number, string).

string

Descrição do campo de saída.

string

Nome da propriedade (ex: CNPJ).

string

URL da imagem do ícone.

Descrição da Resposta

Abaixo você verá a descrição da resposta da atualização da função

string

required

Identificador único universal (UUID) da função.

string

required

Identificador da instituição à qual esta função pertence.

string

required

ID do usuário.

string

required

Identificador da unidade.

string

required

Nome identificador da função (ex: onboardinAI).

string

required

Descrição da função.

string

required

O corpo do código JavaScript que será executado pela função.

boolean

required

Indica se a função está disponível para uso (true) ou desabilitada (false).

boolean

required

Define se a integração está ativa e pronta para receber requisições de gatilho.

string

required

Código ou nome da cor (ex: red) utilizada para rotular a função na interface do usuário.

string

Referência única para o arquivo de imagem armazenado que serve como ícone.

object

Objeto contendo metadados do arquivo de imagem.

Show Propriedades de PluginIcon

string

URL da imagem do ícone.

string

Nome do arquivo armazenado no dataset.

string

Formato do arquivo (ex: jpeg, png).

number

Tamanho do arquivo em bytes.

array

Lista de parâmetros que a função retorna ou exige como mapeamento.

Show Propriedades de Outputs

string

Nome da chave de dado (ex: CNPJ).

string

Tipo primitivo do dado esperado (ex: number, string).

string

Explicação do que aquele output representa para o usuário final.

boolean

Define se este campo de saída deve obrigatoriamente retornar um valor.

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.

​Token de Acesso

​Corpo da Requisição

​Descrição da Resposta

​Segurança

Token de Acesso

Corpo da Requisição

Descrição da Resposta

Segurança