Skip to main content
POST
Create an Audience

Body

application/json
name
string
required

Name of the audience to create

Example:

"Q2 Enterprise Prospects"

contact_ids
string<uuid>[] | null

Optional list of contact IDs to add to the audience on creation. Provide either contact_ids or filters, not both.

Maximum array length: 10000
filters
FilterRule · object
excluded_ids
string<uuid>[] | null

Contact IDs to exclude from the filtered set. Only used with filters.

Maximum array length: 10000
source_audience_id
string<uuid> | null

When set with filters, restricts the selected contacts to current members of this audience.

Response

Successful Response

data
AudienceResponse · object
required
meta
ResponseMeta · object