Add

Overview 

Adds a new filter definition to your account

Syntax 

Add(1)

Function Properties 

OrdinalTypeDescription
1objectRequiredJSON object including properties of new filter definition

Example 

This example code adds a filter definition to your account.

1var filterObj = { Property : "LuckyNumber", SimpleOperator : "equals", Value : 77 };
2
3var newFD = {
4    Name : "SSJS Filter Definition"
5    CustomerKey : "myFilterDef",
6    Filter : filterObj,
7    DataSource : {
8        Type : "SubscriberList",
9        CustomerKey : "example_list_key"
10    }
11};
12
13var status = FilterDefinition.Add(newFD);

This example code adds a complex filter definition.

1var filterObj = {
2  LeftOperand: {
3    Property: "LuckyNumber",
4    SimpleOperator: "equals",
5    Value: 77
6  },
7  LogicalOperator: "AND",
8  RightOperand: {
9    Property: "UnluckyNumber",
10    SimpleOperator: "equals",
11    Value: 13
12  }
13};
14var newFD = {
15  Name: "SSJS Filter Definition",
16  CustomerKey: "myFilterDef",
17  Filter: filterObj,
18  DataSource: {
19    Type: "DataExtension",
20    CustomerKey: "example_external_key"
21  }
22};
23try {
24  var result = FilterDefinition.Add(newFD);
25  Write(Stringify(result));
26} catch (e) {
27  Write(Stringify(e));
28}