Update Frontend Action
curl --request PATCH \
--url https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/frontend-actions/{id} \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '
{
"name": "Open Product Modal",
"description": "Opens a modal displaying product details",
"parameters": [
{
"key": "productId",
"type": "string",
"description": "The ID of the product to display",
"required": true
}
],
"icon": "https://example.com/icon.png"
}
'import requests
url = "https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/frontend-actions/{id}"
payload = {
"name": "Open Product Modal",
"description": "Opens a modal displaying product details",
"parameters": [
{
"key": "productId",
"type": "string",
"description": "The ID of the product to display",
"required": True
}
],
"icon": "https://example.com/icon.png"
}
headers = {
"apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Open Product Modal',
description: 'Opens a modal displaying product details',
parameters: [
{
key: 'productId',
type: 'string',
description: 'The ID of the product to display',
required: true
}
],
icon: 'https://example.com/icon.png'
})
};
fetch('https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/frontend-actions/{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://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/frontend-actions/{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([
'name' => 'Open Product Modal',
'description' => 'Opens a modal displaying product details',
'parameters' => [
[
'key' => 'productId',
'type' => 'string',
'description' => 'The ID of the product to display',
'required' => true
]
],
'icon' => 'https://example.com/icon.png'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apikey: <api-key>"
],
]);
$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://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/frontend-actions/{id}"
payload := strings.NewReader("{\n \"name\": \"Open Product Modal\",\n \"description\": \"Opens a modal displaying product details\",\n \"parameters\": [\n {\n \"key\": \"productId\",\n \"type\": \"string\",\n \"description\": \"The ID of the product to display\",\n \"required\": true\n }\n ],\n \"icon\": \"https://example.com/icon.png\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("apikey", "<api-key>")
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://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/frontend-actions/{id}")
.header("apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Open Product Modal\",\n \"description\": \"Opens a modal displaying product details\",\n \"parameters\": [\n {\n \"key\": \"productId\",\n \"type\": \"string\",\n \"description\": \"The ID of the product to display\",\n \"required\": true\n }\n ],\n \"icon\": \"https://example.com/icon.png\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/frontend-actions/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Open Product Modal\",\n \"description\": \"Opens a modal displaying product details\",\n \"parameters\": [\n {\n \"key\": \"productId\",\n \"type\": \"string\",\n \"description\": \"The ID of the product to display\",\n \"required\": true\n }\n ],\n \"icon\": \"https://example.com/icon.png\"\n}"
response = http.request(request)
puts response.read_body{
"_id": "myapp_onUserClick",
"appId": "my-app-id",
"name": "User Click Action",
"description": "Triggered when a user clicks a button",
"triggerFunction": "onUserClick",
"icon": "https://example.com/icon.png",
"parameters": [
{
"key": "userId",
"type": "string",
"description": "The user identifier",
"required": true
}
],
"tool": {
"name": "onUserClick",
"description": "Triggered when a user clicks a button",
"parameters": {
"type": "object",
"properties": {},
"required": []
}
},
"createdAt": 1700000000000,
"updatedAt": 1700000000000
}Frontend Actions
Update Frontend Action
Updates an existing frontend action by its unique ID. Use this endpoint to modify a frontend action’s parameters, description, or trigger function.
PATCH
/
ai-agents
/
agent-builder
/
frontend-actions
/
{id}
Update Frontend Action
curl --request PATCH \
--url https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/frontend-actions/{id} \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '
{
"name": "Open Product Modal",
"description": "Opens a modal displaying product details",
"parameters": [
{
"key": "productId",
"type": "string",
"description": "The ID of the product to display",
"required": true
}
],
"icon": "https://example.com/icon.png"
}
'import requests
url = "https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/frontend-actions/{id}"
payload = {
"name": "Open Product Modal",
"description": "Opens a modal displaying product details",
"parameters": [
{
"key": "productId",
"type": "string",
"description": "The ID of the product to display",
"required": True
}
],
"icon": "https://example.com/icon.png"
}
headers = {
"apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Open Product Modal',
description: 'Opens a modal displaying product details',
parameters: [
{
key: 'productId',
type: 'string',
description: 'The ID of the product to display',
required: true
}
],
icon: 'https://example.com/icon.png'
})
};
fetch('https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/frontend-actions/{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://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/frontend-actions/{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([
'name' => 'Open Product Modal',
'description' => 'Opens a modal displaying product details',
'parameters' => [
[
'key' => 'productId',
'type' => 'string',
'description' => 'The ID of the product to display',
'required' => true
]
],
'icon' => 'https://example.com/icon.png'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apikey: <api-key>"
],
]);
$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://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/frontend-actions/{id}"
payload := strings.NewReader("{\n \"name\": \"Open Product Modal\",\n \"description\": \"Opens a modal displaying product details\",\n \"parameters\": [\n {\n \"key\": \"productId\",\n \"type\": \"string\",\n \"description\": \"The ID of the product to display\",\n \"required\": true\n }\n ],\n \"icon\": \"https://example.com/icon.png\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("apikey", "<api-key>")
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://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/frontend-actions/{id}")
.header("apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Open Product Modal\",\n \"description\": \"Opens a modal displaying product details\",\n \"parameters\": [\n {\n \"key\": \"productId\",\n \"type\": \"string\",\n \"description\": \"The ID of the product to display\",\n \"required\": true\n }\n ],\n \"icon\": \"https://example.com/icon.png\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/frontend-actions/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Open Product Modal\",\n \"description\": \"Opens a modal displaying product details\",\n \"parameters\": [\n {\n \"key\": \"productId\",\n \"type\": \"string\",\n \"description\": \"The ID of the product to display\",\n \"required\": true\n }\n ],\n \"icon\": \"https://example.com/icon.png\"\n}"
response = http.request(request)
puts response.read_body{
"_id": "myapp_onUserClick",
"appId": "my-app-id",
"name": "User Click Action",
"description": "Triggered when a user clicks a button",
"triggerFunction": "onUserClick",
"icon": "https://example.com/icon.png",
"parameters": [
{
"key": "userId",
"type": "string",
"description": "The user identifier",
"required": true
}
],
"tool": {
"name": "onUserClick",
"description": "Triggered when a user clicks a button",
"parameters": {
"type": "object",
"properties": {},
"required": []
}
},
"createdAt": 1700000000000,
"updatedAt": 1700000000000
}For the complete error reference, see Error Guide.
Authorizations
API Key (i.e. Rest API Key from the Dashboard).
Path Parameters
Body
application/json
Name of the frontend action
Example:
"Open Product Modal"
Description of what the frontend action does
Example:
"Opens a modal displaying product details"
Array of parameters for the frontend action
Show child attributes
Show child attributes
Icon URL for the frontend action
Example:
"https://example.com/icon.png"
Response
200 - application/json
Frontend action updated successfully
Example:
"myapp_onUserClick"
Example:
"my-app-id"
Example:
"User Click Action"
Example:
"Triggered when a user clicks a button"
Example:
"onUserClick"
Example:
"https://example.com/icon.png"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
1700000000000
Example:
1700000000000
Was this page helpful?
⌘I