Add Property to Collection (Lookup) v1.0.0 Help ​

Adds a custom property to an existing Lookup collection.

How can I use the Step? ​

You can use the Step to extend the metadata of your Lookup collections by adding custom properties. It's particularly useful for categorizing, sorting, or providing additional context to the data stored in your collections.

How does the Step work? ​

The Step adds a new property to a specified collection with a provided name, data type, and optional description. It validates input parameters, checks naming conventions, and handles cross-account settings. If successful, it returns updated collection details.

Prerequisites ​

  • An existing Lookup collection to add properties to.
  • For custom authentication, ensure proper cross-account settings with the Super Admin permission level for account and Flow and the necessary account ID or authentication token.

Input settings ​

  • Collection: Lookup collection to add property to. This field is required.
  • Name: property name. It can contain only the following characters /[_A-Za-z][_0-9A-Za-z]*/ and must not include spaces. This field is required.
  • Data type: property data types like string, int, boolean, date, uuid, and their array counterparts. This field is required and defaults to string.
  • Description: property description. This field is optional.

Caution

To specify a property name, avoid using reserved names such as accountId, collection, document, content, and loaderMetadata.

Cross-account settings ​

If you have a proper permission level, you can add a property to a collection in a Lookup service for any Onereach account.

To set up the section, take these steps:

  1. Enable Use custom authentication token.
  2. Choose one of the following access types:
    • Authentication token
    • Account ID
  3. Enter the token or account ID (depending on the chosen access type).

Merge field settings ​

The Step returns the result as a JSON object and stores it under the Merge field name. To learn more about Merge fields and how to work with them, see our Merge fields guide.

Output example ​

The output object has the following properties:

  • id: [string] the id of the collection.
  • accountId: [string] the id of the account that the collection belongs to.
  • name: [string] the name of the collection.
  • description: [string] the description of the collection.
  • properties: [array] an array of objects representing the properties of the collection. Each object has three properties:
    • name: [string] the name of the property.
    • dataType: [string] the data type of the property.
    • description: [string] the description of the property.

Example:

json
{
  "id": "string",
  "accountId": "string",
  "name": "string",
  "description": "string",
  "properties": [
    {
      "name": "string",
      "dataType": "string",
      "description": "string"
    }
  ]
}
{
  "id": "string",
  "accountId": "string",
  "name": "string",
  "description": "string",
  "properties": [
    {
      "name": "string",
      "dataType": "string",
      "description": "string"
    }
  ]
}

Error handling ​

By default, the Step handles errors using a separate exit. So if any error occurs during the Step execution, the Flow proceeds down the error exit. For more information, see Error and timeout handling.

Reporting ​

The Step automatically generates Reporting events during its execution, allowing for real-time tracking and analysis of its performance and user interactions. To learn more, see Reporting events

Service dependencies ​

  • flow builder - v2.28.3
  • event-manager - v2.3.0
  • deployer - v2.6.0
  • library v2.11.3
  • studio v2.64.1

Release notes ​

v1.0.0

  • Initial release