Update an app action tool
curl --request PATCH \
--url https://app.famulor.io/api/v1/tools/app-actions/{toolId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"use_when": "<string>",
"description_override": "<string>",
"fields": [
{
"path": "<string>",
"key": "<string>",
"value": "<unknown>",
"variable": "<string>",
"param": "<string>",
"description": "<string>",
"label": "<string>",
"required": true
}
],
"result_config": {
"paths": [
"<string>"
],
"max_chars": 1850
},
"is_active": true
}
'import requests
url = "https://app.famulor.io/api/v1/tools/app-actions/{toolId}"
payload = {
"connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"use_when": "<string>",
"description_override": "<string>",
"fields": [
{
"path": "<string>",
"key": "<string>",
"value": "<unknown>",
"variable": "<string>",
"param": "<string>",
"description": "<string>",
"label": "<string>",
"required": True
}
],
"result_config": {
"paths": ["<string>"],
"max_chars": 1850
},
"is_active": True
}
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({
connection_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
use_when: '<string>',
description_override: '<string>',
fields: [
{
path: '<string>',
key: '<string>',
value: '<unknown>',
variable: '<string>',
param: '<string>',
description: '<string>',
label: '<string>',
required: true
}
],
result_config: {paths: ['<string>'], max_chars: 1850},
is_active: true
})
};
fetch('https://app.famulor.io/api/v1/tools/app-actions/{toolId}', 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/app-actions/{toolId}",
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([
'connection_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'use_when' => '<string>',
'description_override' => '<string>',
'fields' => [
[
'path' => '<string>',
'key' => '<string>',
'value' => '<unknown>',
'variable' => '<string>',
'param' => '<string>',
'description' => '<string>',
'label' => '<string>',
'required' => true
]
],
'result_config' => [
'paths' => [
'<string>'
],
'max_chars' => 1850
],
'is_active' => 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://app.famulor.io/api/v1/tools/app-actions/{toolId}"
payload := strings.NewReader("{\n \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"use_when\": \"<string>\",\n \"description_override\": \"<string>\",\n \"fields\": [\n {\n \"path\": \"<string>\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\",\n \"variable\": \"<string>\",\n \"param\": \"<string>\",\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"required\": true\n }\n ],\n \"result_config\": {\n \"paths\": [\n \"<string>\"\n ],\n \"max_chars\": 1850\n },\n \"is_active\": true\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/app-actions/{toolId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"use_when\": \"<string>\",\n \"description_override\": \"<string>\",\n \"fields\": [\n {\n \"path\": \"<string>\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\",\n \"variable\": \"<string>\",\n \"param\": \"<string>\",\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"required\": true\n }\n ],\n \"result_config\": {\n \"paths\": [\n \"<string>\"\n ],\n \"max_chars\": 1850\n },\n \"is_active\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/tools/app-actions/{toolId}")
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 \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"use_when\": \"<string>\",\n \"description_override\": \"<string>\",\n \"fields\": [\n {\n \"path\": \"<string>\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\",\n \"variable\": \"<string>\",\n \"param\": \"<string>\",\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"required\": true\n }\n ],\n \"result_config\": {\n \"paths\": [\n \"<string>\"\n ],\n \"max_chars\": 1850\n },\n \"is_active\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"tool_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"binding_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"is_active": true,
"app": "<string>",
"app_name": "<string>",
"action": "<string>",
"action_name": "<string>",
"connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"risk": "read",
"confirmation": "ask_first",
"status": "ok",
"update_available": true,
"version": "<string>",
"fields": [
{
"key": "<string>",
"path": "<string>",
"label": "<string>",
"type": "string",
"required": true,
"allowed_modes": [
"ai"
],
"mode": "ai",
"items": "string",
"columns": [
{
"key": "<string>",
"label": "<string>",
"type": "string",
"required": true,
"enum": [
"<string>"
],
"format": "date"
}
],
"cell_type": "string",
"enum": [
"<string>"
],
"format": "date",
"param": "<string>",
"provider_description": "<string>",
"description": "<string>",
"value": "<unknown>",
"variable": "<string>",
"example": "<string>",
"default_value": "<unknown>"
}
],
"model": {
"use_when": "<string>",
"description_override": "<string>"
},
"result_config": {
"mode": "auto",
"max_chars": 1850,
"paths": [
"<string>"
]
},
"revision": 2
}
}
Tools
Update an app action tool
Change an app action tool. Only the settings you send change; fields are matched by path (or by key when path is missing) and apply onto the tool’s current fields. To delete the tool, remove it from its assistants, then call DELETE /tools/{id}. Requires an owner or admin credential and a plan with Automations. Requires both assistants:write and automations:write.
PATCH
/
tools
/
app-actions
/
{toolId}
Update an app action tool
curl --request PATCH \
--url https://app.famulor.io/api/v1/tools/app-actions/{toolId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"use_when": "<string>",
"description_override": "<string>",
"fields": [
{
"path": "<string>",
"key": "<string>",
"value": "<unknown>",
"variable": "<string>",
"param": "<string>",
"description": "<string>",
"label": "<string>",
"required": true
}
],
"result_config": {
"paths": [
"<string>"
],
"max_chars": 1850
},
"is_active": true
}
'import requests
url = "https://app.famulor.io/api/v1/tools/app-actions/{toolId}"
payload = {
"connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"use_when": "<string>",
"description_override": "<string>",
"fields": [
{
"path": "<string>",
"key": "<string>",
"value": "<unknown>",
"variable": "<string>",
"param": "<string>",
"description": "<string>",
"label": "<string>",
"required": True
}
],
"result_config": {
"paths": ["<string>"],
"max_chars": 1850
},
"is_active": True
}
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({
connection_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
use_when: '<string>',
description_override: '<string>',
fields: [
{
path: '<string>',
key: '<string>',
value: '<unknown>',
variable: '<string>',
param: '<string>',
description: '<string>',
label: '<string>',
required: true
}
],
result_config: {paths: ['<string>'], max_chars: 1850},
is_active: true
})
};
fetch('https://app.famulor.io/api/v1/tools/app-actions/{toolId}', 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/app-actions/{toolId}",
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([
'connection_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'use_when' => '<string>',
'description_override' => '<string>',
'fields' => [
[
'path' => '<string>',
'key' => '<string>',
'value' => '<unknown>',
'variable' => '<string>',
'param' => '<string>',
'description' => '<string>',
'label' => '<string>',
'required' => true
]
],
'result_config' => [
'paths' => [
'<string>'
],
'max_chars' => 1850
],
'is_active' => 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://app.famulor.io/api/v1/tools/app-actions/{toolId}"
payload := strings.NewReader("{\n \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"use_when\": \"<string>\",\n \"description_override\": \"<string>\",\n \"fields\": [\n {\n \"path\": \"<string>\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\",\n \"variable\": \"<string>\",\n \"param\": \"<string>\",\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"required\": true\n }\n ],\n \"result_config\": {\n \"paths\": [\n \"<string>\"\n ],\n \"max_chars\": 1850\n },\n \"is_active\": true\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/app-actions/{toolId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"use_when\": \"<string>\",\n \"description_override\": \"<string>\",\n \"fields\": [\n {\n \"path\": \"<string>\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\",\n \"variable\": \"<string>\",\n \"param\": \"<string>\",\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"required\": true\n }\n ],\n \"result_config\": {\n \"paths\": [\n \"<string>\"\n ],\n \"max_chars\": 1850\n },\n \"is_active\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/tools/app-actions/{toolId}")
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 \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"use_when\": \"<string>\",\n \"description_override\": \"<string>\",\n \"fields\": [\n {\n \"path\": \"<string>\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\",\n \"variable\": \"<string>\",\n \"param\": \"<string>\",\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"required\": true\n }\n ],\n \"result_config\": {\n \"paths\": [\n \"<string>\"\n ],\n \"max_chars\": 1850\n },\n \"is_active\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"tool_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"binding_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"is_active": true,
"app": "<string>",
"app_name": "<string>",
"action": "<string>",
"action_name": "<string>",
"connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"risk": "read",
"confirmation": "ask_first",
"status": "ok",
"update_available": true,
"version": "<string>",
"fields": [
{
"key": "<string>",
"path": "<string>",
"label": "<string>",
"type": "string",
"required": true,
"allowed_modes": [
"ai"
],
"mode": "ai",
"items": "string",
"columns": [
{
"key": "<string>",
"label": "<string>",
"type": "string",
"required": true,
"enum": [
"<string>"
],
"format": "date"
}
],
"cell_type": "string",
"enum": [
"<string>"
],
"format": "date",
"param": "<string>",
"provider_description": "<string>",
"description": "<string>",
"value": "<unknown>",
"variable": "<string>",
"example": "<string>",
"default_value": "<unknown>"
}
],
"model": {
"use_when": "<string>",
"description_override": "<string>"
},
"result_config": {
"mode": "auto",
"max_chars": 1850,
"paths": [
"<string>"
]
},
"revision": 2
}
}
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.
Path Parameters
ID of the app action tool (the id in GET /tools).
Body
application/json
Another connection of the same app.
New tool name the assistant sees.
Pattern:
^[a-zA-Z][a-zA-Z0-9_-]{0,63}$When the assistant should use the tool, for example When the caller asks for a callback.
Required string length:
10 - 1000Replaces the generated tool description the assistant sees. Null uses the generated one.
Maximum string length:
900Field settings, matched by path (or by key when path is missing). Fields you leave out keep their current setting. Send the fields as they were returned or only the ones you change.
Maximum array length:
300Show child attributes
Show child attributes
ask_first: before an action changes data, the assistant reads the values back and calls the tool again to run it. In messaging and email the second call runs only after a new customer message. On calls and in web chat it runs when it comes at least 4 seconds after the read-back, whether or not the customer answered. ask_first is not a consent record. none: the action runs at once. Omit it to keep the current setting; actions that only read never ask.
Available options:
ask_first, none How much of the app's result the assistant reads. Null uses the defaults.
Show child attributes
Show child attributes
Whether assistants can use the tool.
Response
The updated app action tool.
An app action tool with its settings.
Show child attributes
Show child attributes