Skip to content
Home/
REST API Reference
/
/
Predicate

Predicate

A condition used to filter contacts in an audience. An attribute predicate compares one attribute. A logical predicate has a type of and, or or not and groups other predicates instead.

attributestring

The attribute to filter on. Required on an attribute predicate.

Example:"company.name"
typestring

The type of the attribute, or and, or or not on a logical predicate.

Example:"string"
comparisonstring

The comparison operator. Required on an attribute predicate.

Example:"contains"
valueany

The value to compare against. The accepted value depends on the attribute and the comparison, and can be a string, a number, a boolean, an array or null.

Example:"Acme"
predicatesArray of objects(Predicate)

The predicates grouped by a logical predicate. Only used when type is and, or or not.

{
  "attribute": "company.name",
  "type": "string",
  "comparison": "contains",
  "value": "Acme",
  "predicates": [
    { … }
  ]
}