Action ReferencesCollateListsAction
Action References

CollateListsAction

CollateListsAction

Purpose Merges data from one list (source) into another (target) by matching keys. Example: attaching each user’s address list to its corresponding user object.

When to use it

  • Usually after main list operation (afterMainListOperation)
  • Also used in complex enrichments after fetchObjectActions or fetchStatsActions.

Key fields

FieldTypeDescription
sourceListMScriptExpression evaluating to the source array.
targetListMScriptExpression evaluating to the target array.
sourceKeyStringProperty in source objects to match.
targetKeyStringProperty in target objects to match.
nameInTargetStringName of property added to target for collated data.
targetIsArrayBooleanWhether to store multiple matched sources as an array.

Example

{
  "id": "a40-collate-addresses",
  "name": "collateAddresses",
  "sourceList": "this.addressList",
  "targetList": "this.userList",
  "sourceKey": "userId",
  "targetKey": "id",
  "nameInTarget": "addresses",
  "targetIsArray": true
}
Was this page helpful?
Built with Documentation.AI

Last updated Jan 3, 2026