Store a sequence of JavaScript objects in an array.

Basic options

OptionDescription
Label Displays the label used to identify the data variable in the Workflow Studio interface. The label can consist of any text.
Name Displays the name used to identify the data variable in script calls. The name can only consist of alphanumeric and underscore characters. The system automatically converts the label into a valid name by removing or replacing any special characters.
Type Indicates the type of data stored by the data variable.
Mandatory Indicates whether the data variable must contain a value when configured in an action.

Advanced options for Array variables

Option Description
Hint Provides guidance to flow or action designers on how to configure the data.
Max rows Specifies the maximum number of entries to display in the Workflow Studio interface. The array can store more values than it displays.

Advanced options for Object variables

Option Description
Structure Specifies how to structure the object hierarchy. Options include:
  • Create Structure Manually
  • Start from Template
Note: Creating the structure manually enables the Save as Template option. Starting from a template enables the Template option
Save as Template Stores a manually created object structure for later reuse.
Template Specifies the existing object structure to apply to this object.
Note: For more information on using complex object variables, see Complex data.

Example: Create a list of contacts from a list of users

Execution details of a custom action that generates a list of contacts from users in a department.

This example uses a custom action to generate a list of contacts details from users in a specific department. To create the custom action to generate an array of objects, see Create a custom action to generate an array of objects from a list of records.

In this example, the contacts array contains three users from the Development department.
{
    "contacts": 
        "contact": [
            {
                "email_address": "allyson.gillispie@example.com",
                "first_name": "Allyson",
                "last_name": "Gillispie"
            },
            {
                "email_address": "alva.pennigton@example.com",
                "first_name": "Alva",
                "last_name": "Pennigton"
            },
            {
                "email_address": "andrew.och@example.com",
                "first_name": "Andrew",
                "last_name": "Och"
            }
        ]
    }
}