Remove List Entries

Audience: Low-code Engineers

Skill Prerequisites: Actions, Lists, Tokens

Removes the items that match your criteria from a list. Each criterion is a property and a value. An item is removed when every property equals its value exactly. The list is changed in place.

Typical Use Cases

• Remove cancelled or inactive items from a list loaded from JSON, before exporting it
• Remove the item the user just deleted, by its ID, from a list kept for the rest of the actions
• Remove test data, for example items whose Email is test@example.com

Don't use it to

• Filter data you read from a database. Use a WHERE clause in the query of Create List from SQL instead.
• Skip items only while looping. Execute Actions for each List Entry has its own filters.
• Delete records from a database or a listing. The action only changes the list in memory.

Related Actions

Action Name	Description
Add List Entry	Adds an item to a list.
Create List from JSON	Creates a list from a JSON array.
Execute Actions for each List Entry	Runs actions for each item, optionally only for matching items.
Create CSV from List	Exports a list. It has its own criteria to export only some items.
Sort List	Sorts a list. Run it before removing items.

Input Parameter Reference

Parameter	Description	Supports Tokens	Default	Required
List Name	The name of the list to remove items from, for example OrdersList. The name is case-sensitive. If the list doesn't exist, nothing happens. An empty name doesn't use the listing's rows.	Yes	empty string	Yes
Criteria	The items to remove. Each row has a Property, for example Status, and a Value, for example Cancelled. An item is removed when it matches every row. With no rows, nothing is removed. See Matching.	Yes (values)	empty	Yes

Matching

• Exact text. The item's value must be text and equal the criterion's value exactly, including upper and lower case. Cancelled doesn't match cancelled, or Cancelled with a space before it.
• Text values only. Create List from JSON stores every value as text, so all its properties can be matched. Booleans become True and False. Create List from SQL keeps the column types, so number, date and bit columns never match. Convert them to text in the query, for example CAST(OrderId AS nvarchar(20)) AS OrderId.
• Missing and empty values. An item that doesn't have the property, or whose value is empty (null in JSON, NULL in SQL), is never removed. An empty criterion value only matches properties whose value is empty text.
• Property names aren't case-sensitive.
• Tokens in values are replaced once, before the items are checked, with the values from the context. They're the same for every item. You can't use one item's properties to test another.

Considerations

• No error for a missing list. If the list doesn't exist, for example because of a typo, the action does nothing and doesn't fail.
• The count isn't updated. [<List Name>:Count] still holds the number of items before the removal.
• The property definitions are cleared. The list keeps its items and their values, but not its list of properties. Actions that check the property list, such as Sort List, then fail. Sort the list before removing items.
• Listings. In a listing, entering ActionGridEntry replaces the built-in list with a copy that doesn't have the removed records, for the actions that follow. The records themselves aren't changed.
• User Guides. The action is also available in the User Guides module, with the same parameters and behavior.

Examples

tip

To understand how to use the below examples, please see Running Examples.

1. Remove cancelled orders

This action removes the items of OrdersList whose Status is Cancelled.

{
    "Title": "Remove List Entries",
    "ActionType": "RemoveEntities",
    "Description": "Remove cancelled orders",
    "Parameters": {
        "EntityName": "OrdersList",
        "Criteria": [
            {
                "name": "Status",
                "value": "Cancelled"
            }
        ]
    }
}

2. Remove the item a user deleted

This action removes the item of CartList whose ProductId equals the DeletedProductId token and whose Size equals the DeletedSize token. Both must match. CartList was created with Create List from JSON, so ProductId is text and can be matched.

{
    "Title": "Remove List Entries",
    "ActionType": "RemoveEntities",
    "Description": "Remove the deleted product from the cart",
    "Condition": "[DeletedProductId] != \"\"",
    "Parameters": {
        "EntityName": "CartList",
        "Criteria": [
            {
                "name": "ProductId",
                "value": "[DeletedProductId]"
            },
            {
                "name": "Size",
                "value": "[DeletedSize]"
            }
        ]
    }
}

Revised 09/27/2026