Add List Entry
Audience:
Low-code EngineersSkill Prerequisites:
Actions,Lists,Tokens
Adds one entry to a list. You name the list and set the entry's properties, for example Name = [FirstName] [LastName]. If the list doesn't exist yet, it's created.
Run the action again, for example inside Execute Actions for each List Entry, to add more entries. The list can then be used by the other list actions.
The list only exists while the actions run. It isn't saved anywhere and isn't a Plant an App Entity.
Typical Use Cases
- Build a list from form values or tokens, to export it or send it as JSON
- Collect results inside a loop, for example the entries that failed a check
- Add a summary or total entry to a list created from a query
- Build a small list of fixed values to loop over, without a query
Don't use it to
- Load many rows from a database, a file or an API. Use Create List from SQL, Create List from a CSV source, Create List from Excel (.xlsx) or Create List from JSON instead.
- Add a property to entries that already exist. Use Extend List Properties instead.
- Create a single item with properties, to nest in JSON. Use Create Object instead.
Related Actions
| Action Name | Description |
|---|---|
| Execute Actions for each List Entry | Runs actions once for each entry in the list. |
| Extend List Properties | Adds or changes properties on the entries of a list. |
| Remove List Entries | Removes entries from a list. |
| List to JSON | Turns the list into a JSON array. |
| Create CSV from List | Writes the list to a CSV file or token. |
| Create Object | Creates a single object instead of a list entry. |
Input Parameter Reference
| Parameter | Description | Supports Tokens | Default | Required |
|---|---|---|---|---|
| List Name | The name of the list to add the entry to, for example ContactsList. List names are case-sensitive. If no list has this name, a new one is created. | Yes | empty string | Yes |
| Properties | The properties of the new entry. Each row has a List Property Name, for example Email, and a List Property Value, for example [Email]. Both columns support tokens. | Yes | empty | No |
How entries are added
- Values are resolved when the action runs and are saved as text.
- The new entry is added at the end of the list. Entries already in the list are kept, including entries from other actions, such as Create List from SQL.
- The list's property names are replaced by the names in this action. Actions that read the property names of the list, rather than the entries, use the names from the last Add List Entry. Examples are Include All Fields in Create CSV from List, Sort List and the
Listtype in Create JSON Object. - Each entry only has the properties set by the action that added it.
Inside Execute Actions for each List Entry, the properties become tokens such as [ContactsList:Email].
Considerations
- Use the same property names in every Add List Entry for the same list. If entries have different properties, other list actions can show empty values or fail.
- Adding to the list you're looping over. Entries added to a list while Execute Actions for each List Entry is looping over it aren't included in that loop.
- Kept after loops. Entries added inside a loop are kept after it, whatever the loop's
Context Behavior. - Large lists. Each Add List Entry copies the existing entries into a new list. It's fine for tens or hundreds of entries. For thousands, use one of the
Create List fromactions. - Set a List Name. Other list actions use their default list when their
List Nameis empty, so a list added with an empty name can't be used.
Examples
To understand how to use the below examples, please see Running Examples.
1. Add the submitted contact to a list
This action adds an entry with the submitted name and email to ContactsList. If the list doesn't exist, it's created.
{
"Title": "Add List Entry",
"ActionType": "CreateEntity",
"Description": "Add the contact to the list",
"Parameters": {
"EntityName": "ContactsList",
"EntityProps": [
{
"name": "Name",
"value": "[FirstName] [LastName]"
},
{
"name": "Email",
"value": "[Email]"
}
]
}
}
2. Collect the high-value orders in a loop
This action loops over OrdersList and adds the orders with a total above 1000 to LargeOrdersList. The new list is kept after the loop.
{
"Title": "Execute Actions for each List Entry",
"ActionType": "ExecuteActionsOnEntityList",
"Description": "Find the large orders",
"Parameters": {
"EntityName": "OrdersList",
"Filters": [],
"ContextBehavior": {
"Expression": "",
"Value": "NoPreserve",
"IsExpression": false,
"Parameters": {}
},
"ActionList": [
{
"Title": "Add List Entry",
"ActionType": "CreateEntity",
"Description": "Remember the order",
"Condition": "[OrdersList:Total] > 1000",
"Parameters": {
"EntityName": "LargeOrdersList",
"EntityProps": [
{
"name": "OrderId",
"value": "[OrdersList:OrderId]"
},
{
"name": "Total",
"value": "[OrdersList:Total]"
}
]
}
}
],
"ContinueOnError": false,
"OnError": []
}
}
Revised 09/27/2026