curl --request PATCH \
--url https://app.famulor.io/api/v1/tools/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "Look up an order by its number.",
"is_active": false,
"expected_revision": 4
}
'import requests
url = "https://app.famulor.io/api/v1/tools/{id}"
payload = {
"description": "Look up an order by its number.",
"is_active": False,
"expected_revision": 4
}
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({
description: 'Look up an order by its number.',
is_active: false,
expected_revision: 4
})
};
fetch('https://app.famulor.io/api/v1/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://app.famulor.io/api/v1/tools/{id}",
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([
'description' => 'Look up an order by its number.',
'is_active' => false,
'expected_revision' => 4
]),
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://app.famulor.io/api/v1/tools/{id}"
payload := strings.NewReader("{\n \"description\": \"Look up an order by its number.\",\n \"is_active\": false,\n \"expected_revision\": 4\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://app.famulor.io/api/v1/tools/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"Look up an order by its number.\",\n \"is_active\": false,\n \"expected_revision\": 4\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/tools/{id}")
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 \"description\": \"Look up an order by its number.\",\n \"is_active\": false,\n \"expected_revision\": 4\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "f1b2c3d4-0000-4000-8000-000000000010",
"name": "check_order_status",
"description": "Look up the status of a customer order by order number.",
"type": "api",
"config": {
"method": "GET",
"url": "https://api.example.com/orders/status",
"headers": {
"Authorization": "•••"
},
"parameters": [
{
"name": "order_number",
"type": "string",
"description": "The order number",
"required": true,
"source": "llm",
"location": "query"
}
],
"static_values": {},
"response_mapping": {},
"timeout_ms": 10000,
"async": false,
"filler_phrase": "One moment, I am checking that for you."
},
"is_active": true,
"created_at": "2026-07-01T09:00:00Z",
"updated_at": "2026-07-01T09:00:00Z"
}
}Update a tool
Revision-protected partial update. type is immutable. Sending ••• for a secret keeps the stored value. A provided config replaces the stored configuration: send back every header from the read response (masked values as •••); omitted headers are removed. For a Browser Use tool, send the saved login back as well (password and authenticator key as •••); omitting it removes the login. For an app action tool (app_action is set) only name and is_active change here; any other change returns 409, use PATCH /tools/app-actions/{toolId} instead. A stale revision returns 409 revision_conflict. Required scope: assistants:write.
curl --request PATCH \
--url https://app.famulor.io/api/v1/tools/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "Look up an order by its number.",
"is_active": false,
"expected_revision": 4
}
'import requests
url = "https://app.famulor.io/api/v1/tools/{id}"
payload = {
"description": "Look up an order by its number.",
"is_active": False,
"expected_revision": 4
}
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({
description: 'Look up an order by its number.',
is_active: false,
expected_revision: 4
})
};
fetch('https://app.famulor.io/api/v1/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://app.famulor.io/api/v1/tools/{id}",
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([
'description' => 'Look up an order by its number.',
'is_active' => false,
'expected_revision' => 4
]),
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://app.famulor.io/api/v1/tools/{id}"
payload := strings.NewReader("{\n \"description\": \"Look up an order by its number.\",\n \"is_active\": false,\n \"expected_revision\": 4\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://app.famulor.io/api/v1/tools/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"Look up an order by its number.\",\n \"is_active\": false,\n \"expected_revision\": 4\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/tools/{id}")
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 \"description\": \"Look up an order by its number.\",\n \"is_active\": false,\n \"expected_revision\": 4\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "f1b2c3d4-0000-4000-8000-000000000010",
"name": "check_order_status",
"description": "Look up the status of a customer order by order number.",
"type": "api",
"config": {
"method": "GET",
"url": "https://api.example.com/orders/status",
"headers": {
"Authorization": "•••"
},
"parameters": [
{
"name": "order_number",
"type": "string",
"description": "The order number",
"required": true,
"source": "llm",
"location": "query"
}
],
"static_values": {},
"response_mapping": {},
"timeout_ms": 10000,
"async": false,
"filler_phrase": "One moment, I am checking that for you."
},
"is_active": true,
"created_at": "2026-07-01T09:00:00Z",
"updated_at": "2026-07-01T09:00:00Z"
}
}Authorizations
API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, billing:write, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access within the workspace's available capabilities.
Body
Create/update payload for a reusable tool. On update, type is immutable and sending ••• for a secret config value keeps the stored value unchanged.
Type-specific configuration. api: { method, url, headers, parameters[], static_values, response_mapping, timeout_ms, async, filler_phrase, speak_after }; a string parameter may list its allowed values in enum. speak_after (default true): when false, the tool completes silently without an LLM spoken reply. mcp: { url, auth_type, auth_header_name, auth_value_encrypted, allowed_tools[], tool_options: { [toolName]: { cancellable, on_duplicate, report_progress } }, timeout_ms }; on_duplicate is allow, reject, replace, or confirm, and replace requires cancellation. For a native integration (kit connector) mcp also takes caller_recognition (boolean): look the caller up in the connected system before the conversation; omitted on create it defaults to true for integrations that can recognise callers, omitted on update it stays unchanged, and it is not stored for other MCP tools. builtin: exactly one built-in tool item { type: call_transfer|warm_call_transfer|end_call|…|collect_payment_card|set_variable, description?, stripe_connection_id? for collect_payment_card, allowed_keys? for set_variable, ... } — same shape as one element of an assistant's builtin_tools array; secrets are masked as ••• in responses. For browser_use the item is { start_url, allowed_hosts[], browser_instructions?, required_inputs[]?, wait_message?, login?, mode?, flow? }; mode flow replays the recorded flow (recorded in the tool editor) and its {Placeholders} become the tool parameters, while mode and flow omitted on update are kept; wait_message (max 500 characters) is spoken to the caller while a browser task runs, unless the assistant already said something, and an empty value uses a default wait message; the optional login saves a website sign-in (password method with optional authenticator key, or a Salesforce connection) whose password and totp_secret are read back as •••; send login back unchanged to keep it, because a provided config replaces the stored one. For warm_call_transfer, optional post_answer_dtmf accepts up to 32 characters (0-9*#A-D and w, case-insensitive); each w is a fixed half-second pause after answer and before the briefing. Omit or clear it for a direct destination. For call_transfer and warm_call_transfer, optional transfer_hours_enabled, transfer_hours (weekly windows, overnight allowed), timezone (IANA; empty = assistant timezone) and transfer_hours_note limit when the tool may transfer; outside those hours it never dials and the assistant receives the next possible time. See BuiltinTool for field constraints. Saved caller-facing announcements, filler phrases and end-call farewells remain editable. With secondary languages configured on the assistant, they guide generated wording in the current supported conversation language without fixed saved audio. Otherwise their existing delivery behavior is preserved. An empty End call farewell adds no speech.