Skip to main content
PATCH
Update Frontend Action
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

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[]
tool
object
createdAt
number
Example:

1700000000000

updatedAt
number
Example:

1700000000000