MOmonaco
Audiences

Create an Audience

Changed on

Creates a new audience, optionally seeded with contacts — either an explicit contact_ids list or a filters query over the contacts field schemas (optionally narrowed by excluded_ids or source_audience_id).

Audiences can be shared across campaigns.

post/v1/audiences

Request

  • Base URL
    https://api.monaco.com
  • URL
    https://api.monaco.com/v1/audiences
  • Auth
    none declared

Request body

namestring required

Name of the audience to create

contact_idsstring[] nullable

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

excluded_idsstring[] nullable

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

source_audience_idstring uuid nullable

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

Example request

{
  "name": "Q2 Enterprise Prospects"
}

Response

Successful Response

Example response

{
  "data": {
    "id": "aud_abc123",
    "name": "Q2 Enterprise Prospects",
    "type": "static",
    "status": "active",
    "contact_count": 42
  }
}

Changes