Assistants

Update assistant action

Update an existing assistant action.

patch/orgs/assistants/{assistant_id}/actions/{action_id}

Request

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

Path parameters

assistant_idstring required

The ID of the assistant

action_idstring required

The ID of the assistant action

Request body

enabledboolean

Whether the action is available to the assistant.

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'

When the assistant must ask for approval in the chat before running the action. Always use "never" (run without asking).

Example request

{
  "connection_id": "con_XXX"
}

Response

The updated assistant 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"

assistant_idstring required

The ID of the assistant

connection_idstring nullable required

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

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

When the assistant must ask before running the action

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",
  "assistant_id": "ast_XXX",
  "connection_id": "con_XXX"
}

Changes

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