Skip to content
Home/
REST API Reference
/
/
Audience

Audience

An audience represents a group of contacts that can be targeted by Fin.

typestring

The type of object.

Value:"audience"
Example:"audience"
idstringread-only

The unique identifier representing the audience.

Example:"123"
namestring

The name of the audience.

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

The predicates that define the audience matching rules.

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

The role predicates that define audience role-based matching rules.

Example:
[
  {
    "attribute": "role",
    "type": "role",
    "comparison": "eq",
    "value": "user"
  }
]
created_atintegerread-only

The time the audience was created as a Unix timestamp.

Example:1717200000
updated_atintegerread-only

The time the audience was last updated as a Unix timestamp.

Example:1717200000
{
  "type": "audience",
  "id": "123",
  "name": "VIP Customers",
  "predicates": [
    { … }
  ],
  "role_predicates": [
    { … }
  ],
  "created_at": 1717200000,
  "updated_at": 1717200000
}