Skip to content
Home/
REST API Reference
/
/
Create Audience Request

Create Audience Request

The request payload for creating an audience.

namestringrequired

The name of the audience.

Example:"VIP Customers"
predicatesArray of objects(Predicate)

The predicates that define which contacts belong to the audience.

Example:
[
  {
    "attribute": "company.name",
    "type": "string",
    "comparison": "contains",
    "value": "Acme"
  }
]
role_predicatesArray of objects(Predicate)

Role-based predicates that further filter audience membership by contact role.

Example:
[
  {
    "attribute": "role",
    "type": "role",
    "comparison": "eq",
    "value": "user"
  }
]
{
  "name": "VIP Customers",
  "predicates": [
    { … }
  ],
  "role_predicates": [
    { … }
  ]
}