Extend Object Properties
Audience:
Low-code EngineersSkill Prerequisites:
Actions,Lists,JSON
Adds properties to an object created with Create Object, or changes the value of existing ones. Like in Create Object, a property can be a plain value, or point to a list or to another object.
Use it to fill in an object step by step, for example add a property only when a condition is true, or link objects that were created in any order.
Typical Use Cases
- Add optional properties to an object, each with its own condition
- Link two objects after both are created, for example add a
billingAddressproperty to anOrderobject - Attach a list to an object once the list is complete, for example after a loop
- Update a value, such as a status, before building the JSON
Don't use it to
- Create an object. Use Create Object first. If the object doesn't exist, this action does nothing.
- Change list entries. Use Extend List Properties instead.
Related Actions
| Action Name | Description |
|---|---|
| Create Object | Creates the object. |
| Create JSON Object | Turns the object into JSON, with the List Object type. |
| Extend List Properties | Adds properties to list entries instead. |
| Add List Entry | Adds entries to a list, which an object property can point to. |
Input Parameter Reference
| Parameter | Description | Supports Tokens | Default | Required |
|---|---|---|---|---|
| Object Name | The name of the object to change, for example Order. Names are case-sensitive. If no object has this name, nothing happens. | Yes | empty string | Yes |
| Object Properties | The properties to add or change. Each row has a Property Name, a Property Value and a Property Type: Property (default) for a plain value, ListProperty for the name of a list, or ObjectProperty for the name of another object. See Property types. All three columns support tokens. | Yes | empty | No |
Considerations
- Existing properties with the same name are overwritten, including their type. Other properties are kept.
- No error for a missing object. If
Object Namedoesn't match an object, for example because of a typo or different case, the action silently does nothing. Check the name if properties are missing from the JSON. - Objects aren't lists. Only objects from Create Object can be changed. List names don't work here.
- References are names. For
ListPropertyandObjectProperty, only the name is saved. The list or object is looked up when Create JSON Object runs, so it must exist by then. Create JSON Object fails with an "infinite loop" error if objects point to each other in a circle. - No tokens. Object properties don't become tokens.
Examples
To understand how to use the below examples, please see Running Examples.
1. Add a gift message only when there is one
This action adds a giftMessage property to the Order object, which was created earlier with Create Object. The condition skips it when the GiftMessage token is empty, so the JSON doesn't contain an empty property.
{
"Title": "Extend Object Properties",
"ActionType": "ExtendEntityItem",
"Description": "Add the gift message",
"Condition": "[GiftMessage] != \"\"",
"Parameters": {
"EntityItemName": "Order",
"EntityProps": [
{
"PropertyName": "giftMessage",
"PropertyValue": "[GiftMessage]",
"PropertyType": "Property"
}
]
}
}
2. Link an address and a list of lines
This action adds two references to the Order object: shippingAddress points to the ShippingAddress object, and lines points to the LinesList list. Both must exist when Create JSON Object runs.
{
"Title": "Extend Object Properties",
"ActionType": "ExtendEntityItem",
"Description": "Link the address and the lines",
"Parameters": {
"EntityItemName": "Order",
"EntityProps": [
{
"PropertyName": "shippingAddress",
"PropertyValue": "ShippingAddress",
"PropertyType": "ObjectProperty"
},
{
"PropertyName": "lines",
"PropertyValue": "LinesList",
"PropertyType": "ListProperty"
}
]
}
}
Revised 09/27/2026