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

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"
}
'

200

{
  "_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

apikey · string · header · required

API Key (i.e. Rest API Key from the Dashboard).

Path Parameters

id · string · required

Body

application/json

name · string

Name of the frontend action

Example:

"Open Product Modal"

description · string

Description of what the frontend action does

Example:

"Opens a modal displaying product details"

parameters · object[]

Array of parameters for the frontend action

Show child attributes

icon · string

Icon URL for the frontend action

Example:

"https://example.com/icon.png"

Response

200 - application/json

Frontend action updated successfully

_id · string

Example:

"myapp_onUserClick"

appId · string

Example:

"my-app-id"

name · string

Example:

"User Click Action"

description · string

Example:

"Triggered when a user clicks a button"

triggerFunction · string

Example:

"onUserClick"

icon · string

Example:

"https://example.com/icon.png"

parameters · object[]

Show child attributes

tool · object

Show child attributes

createdAt · number

Example:

1700000000000

updatedAt · number

Example:

1700000000000