Atualizar ferramenta de chamada

curl --request PUT \
  --url https://suasofia.online/api/user/tools/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "endpoint": "<string>",
  "method": "<string>",
  "body_format": "<string>",
  "timeout": 123,
  "headers": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "static_fields": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "schema": [
    {
      "name": "<string>",
      "type": "<string>",
      "description": "<string>",
      "required": true
    }
  ]
}
'

import requests

url = "https://suasofia.online/api/user/tools/{id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "endpoint": "<string>",
    "method": "<string>",
    "body_format": "<string>",
    "timeout": 123,
    "headers": [
        {
            "name": "<string>",
            "value": "<string>"
        }
    ],
    "static_fields": [
        {
            "key": "<string>",
            "value": "<string>"
        }
    ],
    "schema": [
        {
            "name": "<string>",
            "type": "<string>",
            "description": "<string>",
            "required": True
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    endpoint: '<string>',
    method: '<string>',
    body_format: '<string>',
    timeout: 123,
    headers: [{name: '<string>', value: '<string>'}],
    static_fields: [{key: '<string>', value: '<string>'}],
    schema: [{name: '<string>', type: '<string>', description: '<string>', required: true}]
  })
};

fetch('https://suasofia.online/api/user/tools/{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://suasofia.online/api/user/tools/{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>',
    'endpoint' => '<string>',
    'method' => '<string>',
    'body_format' => '<string>',
    'timeout' => 123,
    'headers' => [
        [
                'name' => '<string>',
                'value' => '<string>'
        ]
    ],
    'static_fields' => [
        [
                'key' => '<string>',
                'value' => '<string>'
        ]
    ],
    'schema' => [
        [
                'name' => '<string>',
                'type' => '<string>',
                'description' => '<string>',
                'required' => true
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://suasofia.online/api/user/tools/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"method\": \"<string>\",\n  \"body_format\": \"<string>\",\n  \"timeout\": 123,\n  \"headers\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"static_fields\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"schema\": [\n    {\n      \"name\": \"<string>\",\n      \"type\": \"<string>\",\n      \"description\": \"<string>\",\n      \"required\": true\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://suasofia.online/api/user/tools/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"method\": \"<string>\",\n  \"body_format\": \"<string>\",\n  \"timeout\": 123,\n  \"headers\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"static_fields\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"schema\": [\n    {\n      \"name\": \"<string>\",\n      \"type\": \"<string>\",\n      \"description\": \"<string>\",\n      \"required\": true\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://suasofia.online/api/user/tools/{id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"method\": \"<string>\",\n  \"body_format\": \"<string>\",\n  \"timeout\": 123,\n  \"headers\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"static_fields\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"schema\": [\n    {\n      \"name\": \"<string>\",\n      \"type\": \"<string>\",\n      \"description\": \"<string>\",\n      \"required\": true\n    }\n  ]\n}"

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

{
  "message": "Ferramenta atualizada com sucesso",
  "data": {
    "id": 1,
    "name": "update_customer_info",
    "description": "Use esta ferramenta para atualizar informações do cliente no sistema.",
    "type": "http",
    "endpoint": "https://api.suacompanhia.com.br/customers/update",
    "method": "POST",
    "body_format": "json",
    "timeout": 15,
    "headers": [
      {
        "name": "Content-Type",
        "value": "application/json"
      }
    ],
    "static_fields": [
      {
        "key": "source",
        "value": "suasofia"
      }
    ],
    "schema": [
      {
        "name": "customer_name",
        "type": "string",
        "description": "Nome completo do cliente",
        "required": true
      },
      {
        "name": "balance",
        "type": "float",
        "description": "Saldo da conta como um decimal",
        "required": false
      },
      {
        "name": "newsletter_subscription",
        "type": "boolean",
        "description": "Se o cliente deseja se inscrever na newsletter",
        "required": false
      }
    ],
    "created_at": "2025-10-10T12:00:00.000000Z",
    "updated_at": "2025-10-10T14:30:00.000000Z"
  }
}

{
  "message": "Ferramenta não encontrada"
}

{
  "message": "Validação falhou",
  "errors": {
    "name": ["O nome da ferramenta deve começar com uma letra ou sublinhado e conter apenas letras, números e sublinhados (máx. 64 caracteres)."]
  }
}

PUT

user

tools

{id}

Atualizar ferramenta de chamada

curl --request PUT \
  --url https://suasofia.online/api/user/tools/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "endpoint": "<string>",
  "method": "<string>",
  "body_format": "<string>",
  "timeout": 123,
  "headers": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "static_fields": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "schema": [
    {
      "name": "<string>",
      "type": "<string>",
      "description": "<string>",
      "required": true
    }
  ]
}
'

import requests

url = "https://suasofia.online/api/user/tools/{id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "endpoint": "<string>",
    "method": "<string>",
    "body_format": "<string>",
    "timeout": 123,
    "headers": [
        {
            "name": "<string>",
            "value": "<string>"
        }
    ],
    "static_fields": [
        {
            "key": "<string>",
            "value": "<string>"
        }
    ],
    "schema": [
        {
            "name": "<string>",
            "type": "<string>",
            "description": "<string>",
            "required": True
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    endpoint: '<string>',
    method: '<string>',
    body_format: '<string>',
    timeout: 123,
    headers: [{name: '<string>', value: '<string>'}],
    static_fields: [{key: '<string>', value: '<string>'}],
    schema: [{name: '<string>', type: '<string>', description: '<string>', required: true}]
  })
};

fetch('https://suasofia.online/api/user/tools/{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://suasofia.online/api/user/tools/{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>',
    'endpoint' => '<string>',
    'method' => '<string>',
    'body_format' => '<string>',
    'timeout' => 123,
    'headers' => [
        [
                'name' => '<string>',
                'value' => '<string>'
        ]
    ],
    'static_fields' => [
        [
                'key' => '<string>',
                'value' => '<string>'
        ]
    ],
    'schema' => [
        [
                'name' => '<string>',
                'type' => '<string>',
                'description' => '<string>',
                'required' => true
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://suasofia.online/api/user/tools/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"method\": \"<string>\",\n  \"body_format\": \"<string>\",\n  \"timeout\": 123,\n  \"headers\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"static_fields\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"schema\": [\n    {\n      \"name\": \"<string>\",\n      \"type\": \"<string>\",\n      \"description\": \"<string>\",\n      \"required\": true\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://suasofia.online/api/user/tools/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"method\": \"<string>\",\n  \"body_format\": \"<string>\",\n  \"timeout\": 123,\n  \"headers\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"static_fields\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"schema\": [\n    {\n      \"name\": \"<string>\",\n      \"type\": \"<string>\",\n      \"description\": \"<string>\",\n      \"required\": true\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://suasofia.online/api/user/tools/{id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"method\": \"<string>\",\n  \"body_format\": \"<string>\",\n  \"timeout\": 123,\n  \"headers\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"static_fields\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"schema\": [\n    {\n      \"name\": \"<string>\",\n      \"type\": \"<string>\",\n      \"description\": \"<string>\",\n      \"required\": true\n    }\n  ]\n}"

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

{
  "message": "Ferramenta atualizada com sucesso",
  "data": {
    "id": 1,
    "name": "update_customer_info",
    "description": "Use esta ferramenta para atualizar informações do cliente no sistema.",
    "type": "http",
    "endpoint": "https://api.suacompanhia.com.br/customers/update",
    "method": "POST",
    "body_format": "json",
    "timeout": 15,
    "headers": [
      {
        "name": "Content-Type",
        "value": "application/json"
      }
    ],
    "static_fields": [
      {
        "key": "source",
        "value": "suasofia"
      }
    ],
    "schema": [
      {
        "name": "customer_name",
        "type": "string",
        "description": "Nome completo do cliente",
        "required": true
      },
      {
        "name": "balance",
        "type": "float",
        "description": "Saldo da conta como um decimal",
        "required": false
      },
      {
        "name": "newsletter_subscription",
        "type": "boolean",
        "description": "Se o cliente deseja se inscrever na newsletter",
        "required": false
      }
    ],
    "created_at": "2025-10-10T12:00:00.000000Z",
    "updated_at": "2025-10-10T14:30:00.000000Z"
  }
}

{
  "message": "Ferramenta não encontrada"
}

{
  "message": "Validação falhou",
  "errors": {
    "name": ["O nome da ferramenta deve começar com uma letra ou sublinhado e conter apenas letras, números e sublinhados (máx. 64 caracteres)."]
  }
}

Este endpoint permite que você atualize uma ferramenta de chamada existente. Todos os campos são opcionais - forneça apenas os campos que deseja atualizar.

Parâmetros de Caminho

integer

required

O identificador único da ferramenta a ser atualizada

Parâmetros do Corpo

Para ferramentas vinculadas a um fluxo da Plataforma de Automação, os campos endpoint, method e body_format são ignorados para proteger a conexão do fluxo.

string

Nome da ferramenta — letras, números e sublinhados, começando com uma letra ou sublinhado (máx. 64 caracteres)

string

Explicação detalhada de quando e como a IA deve usar esta ferramenta (máx. 255 caracteres)

string

URL válida do endpoint da API a ser chamada (máx. 2048 caracteres)

string

Método HTTP: GET, POST, PUT, PATCH ou DELETE

string

Codificação do corpo da solicitação para métodos de gravação: json (padrão) ou form

integer

Tempo limite da solicitação em segundos (1-30)

array

Cabeçalhos HTTP a serem enviados com a solicitação (substitui cabeçalhos existentes)

Show propriedades dos cabeçalhos

string

required

Nome do cabeçalho

string

required

Valor do cabeçalho (suporta substituição {{variável}})

array

Pares chave/valor fixos sempre enviados com a solicitação (substitui campos estáticos existentes)

Show propriedades de campos estáticos

string

required

Chave do campo (máx. 64 caracteres)

string

Valor do campo (máx. 2048 caracteres; suporta substituição {{variável}})

array

Esquema de parâmetros (substitui o esquema existente)

Show propriedades do esquema

string

required

Nome do parâmetro (1-64 caracteres, começando com uma letra ou sublinhado)

string

required

Tipo do parâmetro: string, number, float ou boolean

string

required

Descrição do parâmetro (3-255 caracteres)

boolean

Se a IA deve coletar este parâmetro (padrão false)

Campos de Resposta

string

Mensagem de sucesso

object

O objeto da ferramenta atualizada com todos os valores atuais

{
  "message": "Ferramenta atualizada com sucesso",
  "data": {
    "id": 1,
    "name": "update_customer_info",
    "description": "Use esta ferramenta para atualizar informações do cliente no sistema.",
    "type": "http",
    "endpoint": "https://api.suacompanhia.com.br/customers/update",
    "method": "POST",
    "body_format": "json",
    "timeout": 15,
    "headers": [
      {
        "name": "Content-Type",
        "value": "application/json"
      }
    ],
    "static_fields": [
      {
        "key": "source",
        "value": "suasofia"
      }
    ],
    "schema": [
      {
        "name": "customer_name",
        "type": "string",
        "description": "Nome completo do cliente",
        "required": true
      },
      {
        "name": "balance",
        "type": "float",
        "description": "Saldo da conta como um decimal",
        "required": false
      },
      {
        "name": "newsletter_subscription",
        "type": "boolean",
        "description": "Se o cliente deseja se inscrever na newsletter",
        "required": false
      }
    ],
    "created_at": "2025-10-10T12:00:00.000000Z",
    "updated_at": "2025-10-10T14:30:00.000000Z"
  }
}

{
  "message": "Ferramenta não encontrada"
}

{
  "message": "Validação falhou",
  "errors": {
    "name": ["O nome da ferramenta deve começar com uma letra ou sublinhado e conter apenas letras, números e sublinhados (máx. 64 caracteres)."]
  }
}

Gerenciando Atribuições de Ferramentas

Para anexar ou desanexar esta ferramenta de assistentes, use a API de Assistente:

Criar Assistente - Use o parâmetro tool_ids para anexar ferramentas ao criar um assistente
Atualizar Assistente - Use o parâmetro tool_ids para gerenciar quais ferramentas estão atribuídas a um assistente

Referência da API

Assistentes

Folders

Labels

Chamadas

Conversas

AI

Mid Call Tools

Leads

Campaigns

Números de Telefone

SIP Trunks

Knowledgebases

SMS

WhatsApp

Webhooks

Chaves da API

Atualizar ferramenta de chamada

Parâmetros de Caminho

Parâmetros do Corpo

Campos de Resposta

Gerenciando Atribuições de Ferramentas

​Parâmetros de Caminho

​Parâmetros do Corpo

​Campos de Resposta

​Gerenciando Atribuições de Ferramentas

Parâmetros de Caminho

Parâmetros do Corpo

Campos de Resposta

Gerenciando Atribuições de Ferramentas