The Update an item by ID tool allows an AI Agent to modify specific fields of an existing record in a selected data list. The agent uses the item’s unique ID to locate the record and update only the fields you configure.
Accessing the Tools Page
Open the target AI Agent.
Click Tools in the top navigation.
View, enable/disable, edit, or delete existing tools.
Click Add a tool to create a new tool.
Adding the “Update an item by ID” Tool
After clicking Add a tool, select:
Update an item by ID — Modify specific fields of an existing record using its ID
Then:
Choose application – select the application containing the list
Data source – select the list where the item will be updated
Choose Add or Add and configure
General Settings
This tool includes the same general settings as other AI Agent tools:
Detail – Name, Description, Tool type, Application, Data source
Credentials to use – End user credentials or Specific user
These settings function consistently across tools.
For more details, refer to: AI agent.
Inputs – Fields Used When Updating an Item
The Update an item by ID tool includes one default input:
Default Input: Item Id
Column | Description |
Input name | Item Id |
Input type | Single line |
Fill using | Typically “Dynamically fill with AI” so the AI provides the correct record ID |
Value | Optional Custom value |
The Item Id is mandatory. Without it, the system cannot identify which record to update.
Adding and configuring inputs for fields to update
To specify which fields the AI Agent is allowed to update, click + Add input.
The popup dialog lists all fields in the selected data list—including each field’s Input name, ID, and Input type (Single line, Number, Date, etc.). Select the fields you want to allow updates for, then click OK.
The selected fields will appear in the Inputs table, where each row represents a field that can be updated. For each field, you can configure:
Column | Description |
Input name | The field to be updated |
Input type | Inherited from the list |
Fill using | AI-filled or Custom value |
Value | Required only when using a Custom value |
Only fields added to the Inputs section can be updated by the agent.
You may remove any field using the delete icon.
Required list fields only need to be included if they must be modified.
If the Item Id is missing or invalid, the update will fail.
Completion
Completion defines how the agent proceeds after the tool runs:
After running – choose whether the agent waits for the result
Behaves the same as in other tools, working together with Outputs
Outputs available to the agent and other tools
This section specifies which outputs will be made available after the update action completes.
Default outputs include:
Output | Output type | Description |
Data | Text | Information returned from the update action (e.g., updated fields or confirmation). |
Message | Text | A readable message describing success or failure. |
Status Code | Number | Numeric status indicator such as 200 (success) or 400 (error). |
Managing outputs
Click Customize to configure each output.
Delete outputs you do not need.
Deleted outputs can be added back anytime using the Add output button.
Summary
The Update an item by ID tool enables AI Agents to update specific fields in a record by using its unique ID.
By configuring Inputs and Outputs, you control:
Which fields the agent can modify
How values are supplied
What information is returned to the agent for further processing
This tool is essential for scenarios such as updating contact info, modifying order status, or adjusting inventory data.