Skip to main content
PUT
Update a Specific Action by ID

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

action_id
string
required

ID of the action

Body

application/json
name
string
required

Name of the action

Required string length: 1 - 512
Example:

"get_delivery_date"

parameters
Parameters · object
required

Parameters for the action. It should be a JSON schema object

Example:

false

endpoint
HttpActionEndpoint · object
required

Endpoint for the action

invocationTrigger
enum<string>
required

Trigger who invokes the action

Available options:
user_query,
webhook.conversation_start,
webhook.conversation_end
description
string | null

Description about the action and it should also contain when the action should be triggered

Required string length: 1 - 512
Example:

"Get the delivery date for a customer's order. Call this whenever you need to know the delivery date, for example when a customer asks 'Where is my package'"

userWaitingText
string | null

Text to be rendered to user when action is invoked

Maximum string length: 2048
Example:

"Please wait while we get the delivery date for your order"

userSuccessText
string | null

Text to be rendered to user when action is successful

Maximum string length: 2048
Example:

"We have sent you an email with the delivery date"

userErrorText
string | null

Text to be rendered to user when action is not successful

Maximum string length: 2048
Example:

"We are unable to get the delivery date for your order"

Response

Action updated successfully

Action entity to store the actions which can be performed by ai agents

id
string
orgId
string
name
string
description
string | null
parameters
Parameters · object | null
endpoint
Endpoint · object | null
invocationTrigger
string | null
userWaitingText
string | null
userSuccessText
string | null
userErrorText
string | null
createdBy
string
createdAt
string<date-time>
updatedBy
string
updatedAt
string<date-time>