Update a tool description

cURL

curl --request PATCH \
  --url https://api.teamfollowup.ai/api/agent-builder/agents/{id}/tools \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "toolName": "transfer_call",
  "description": "Use when the caller asks to speak with a person."
}'

import requests

url = "https://api.teamfollowup.ai/api/agent-builder/agents/{id}/tools"

payload = {
    "toolName": "transfer_call",
    "description": "Use when the caller asks to speak with a person."
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    toolName: 'transfer_call',
    description: 'Use when the caller asks to speak with a person.'
  })
};

fetch('https://api.teamfollowup.ai/api/agent-builder/agents/{id}/tools', 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://api.teamfollowup.ai/api/agent-builder/agents/{id}/tools",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'toolName' => 'transfer_call',
    'description' => 'Use when the caller asks to speak with a person.'
  ]),
  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://api.teamfollowup.ai/api/agent-builder/agents/{id}/tools"

	payload := strings.NewReader("{\n  \"toolName\": \"transfer_call\",\n  \"description\": \"Use when the caller asks to speak with a person.\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.teamfollowup.ai/api/agent-builder/agents/{id}/tools")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"toolName\": \"transfer_call\",\n  \"description\": \"Use when the caller asks to speak with a person.\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.teamfollowup.ai/api/agent-builder/agents/{id}/tools")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"toolName\": \"transfer_call\",\n  \"description\": \"Use when the caller asks to speak with a person.\"\n}"

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

{
  "success": true,
  "tool": {
    "name": "transfer_call",
    "type": "transfer_call",
    "description": "Use when the caller asks to speak with a person."
  }
}

{
  "success": false,
  "error": "Unauthorized",
  "message": "Authentication required."
}

{
  "success": false,
  "error": "Unauthorized",
  "message": "Authentication required."
}

{
  "success": false,
  "error": "Unauthorized",
  "message": "Authentication required."
}

{
  "success": false,
  "error": "Unauthorized",
  "message": "Authentication required."
}

{
  "success": false,
  "error": "Unauthorized",
  "message": "Authentication required."
}

{
  "success": false,
  "error": "Unauthorized",
  "message": "Authentication required."
}

PATCH

api

agent-builder

agents

{id}

tools

cURL

curl --request PATCH \
  --url https://api.teamfollowup.ai/api/agent-builder/agents/{id}/tools \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "toolName": "transfer_call",
  "description": "Use when the caller asks to speak with a person."
}'

import requests

url = "https://api.teamfollowup.ai/api/agent-builder/agents/{id}/tools"

payload = {
    "toolName": "transfer_call",
    "description": "Use when the caller asks to speak with a person."
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    toolName: 'transfer_call',
    description: 'Use when the caller asks to speak with a person.'
  })
};

fetch('https://api.teamfollowup.ai/api/agent-builder/agents/{id}/tools', 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://api.teamfollowup.ai/api/agent-builder/agents/{id}/tools",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'toolName' => 'transfer_call',
    'description' => 'Use when the caller asks to speak with a person.'
  ]),
  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://api.teamfollowup.ai/api/agent-builder/agents/{id}/tools"

	payload := strings.NewReader("{\n  \"toolName\": \"transfer_call\",\n  \"description\": \"Use when the caller asks to speak with a person.\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.teamfollowup.ai/api/agent-builder/agents/{id}/tools")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"toolName\": \"transfer_call\",\n  \"description\": \"Use when the caller asks to speak with a person.\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.teamfollowup.ai/api/agent-builder/agents/{id}/tools")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"toolName\": \"transfer_call\",\n  \"description\": \"Use when the caller asks to speak with a person.\"\n}"

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

{
  "success": true,
  "tool": {
    "name": "transfer_call",
    "type": "transfer_call",
    "description": "Use when the caller asks to speak with a person."
  }
}

{
  "success": false,
  "error": "Unauthorized",
  "message": "Authentication required."
}

{
  "success": false,
  "error": "Unauthorized",
  "message": "Authentication required."
}

{
  "success": false,
  "error": "Unauthorized",
  "message": "Authentication required."
}

{
  "success": false,
  "error": "Unauthorized",
  "message": "Authentication required."
}

{
  "success": false,
  "error": "Unauthorized",
  "message": "Authentication required."
}

{
  "success": false,
  "error": "Unauthorized",
  "message": "Authentication required."
}

Authorizations

Authorization

string

header

required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

string

required

Agent id.

Minimum string length: 1

Body

application/json

toolName

string

required

Minimum string length: 1

description

string

required

Maximum string length: 600

Response

Tool description updated.

success

boolean

required

tool

object

required

Show child attributes

Agents

Skills & Tools

Campaigns

Campaign Workflows

Calls

Analytics

Projects

Power Dialer

Contacts

Phone Numbers

Voices

GHL

Authorizations

Path Parameters

Body

Response