Agents

Update agent action

Update an existing agent action.

patch/orgs/agents/{agent_id}/actions/{action_id}

Request

  • Base URL: https://api.useinvent.com
  • URL: https://api.useinvent.com/orgs/agents/{agent_id}/actions/{action_id}
  • Auth: HTTP bearer

Path parameters

agent_idstring required

The ID of the agent

action_idstring required

The ID of the agent action

Request body

enabledboolean

Whether the action is available to the agent.

namestring nullable

The name of the action, e.g. "Send email"

instructionsstring nullable

Extra instructions for the action

connection_idstring nullable

The ID of the connection to use for the action if required, e.g. "con_XXX"

approval_mode'auto' | 'ask' | 'never' | 'null' nullable

When the agent must ask for approval before running the action. Omit or null to inherit the run default.

Example request

{
  "connection_id": "con_XXX"
}

Response

The updated agent action.

idstring required

The ID of the action

enabledboolean required

Whether the action is enabled

namestring nullable required

The name of the action

instructionsstring nullable required

The instructions for the action

action_idstring required

The ID of the action, e.g. "TOOLS:HTTP_REQUEST", or a "TYPE:*" wildcard covering every action of the app

agent_idstring required

The ID of the agent

connection_idstring nullable required

The ID of the connection to use for the action if required

approval_mode'auto' | 'ask' | 'never' nullable required

When the agent must ask for approval before running the action. Null inherits the run default.

positioninteger required

The position of the action within its group. Bucketed in multiples of 100, e.g. 100, 101, 102 for the first group, 200, 201, 202 for the second

created_atstring date-time nullable required
updated_atstring date-time nullable required

Example response

{
  "action_id": "TOOLS:HTTP_REQUEST",
  "agent_id": "agt_XXX",
  "connection_id": "con_XXX"
}

Changes

No recorded changes to this operation across all 1 revision of this API.