v29

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-06-042661,1122.5 MB

audiences

Create audience

Create a new audience for the ad account.

post/ad_accounts/{ad_account_id}/audiences

Path parameters

ad_account_idstring required

Unique identifier of an ad account.

Request body

ad_account_idstring

Ad account ID.

audience_type'CUSTOMER_LIST' | 'VISITOR' | 'ENGAGEMENT' | 'ACTALIKE' | 'PERSONA'

Audience type

descriptionstring nullable

Audience description.

namestring

Audience name.

Example request

{
  "audience_type": "ACTALIKE",
  "rule": {
    "event_data": {
      "lead_type": "Newsletter",
      "line_items": {
        "product_brand": "Parker",
        "product_category": "Shoes",
        "product_id": 1414,
        "product_name": "Parker Boots",
        "product_price": "99.99",
        "product_quantity": 2,
        "product_variant": "Red",
        "product_variant_id": "1414-34832"
      },
      "order_id": "X-151481",
      "order_quantity": 1,
      "page_name": "Our Favorite Pins on Pinterest",
      "promo_code": "WINTER10",
      "property": "Athleta",
      "search_query": "boots",
      "value": "199.98",
      "video_title": "How to style your Parker Boots"
    }
  }
}

Response

The request has succeeded.

ad_account_idstring

Ad account ID.

audience_type'CUSTOMER_LIST' | 'VISITOR' | 'ENGAGEMENT' | 'ACTALIKE' | 'PERSONA'

Audience type

created_by_company_namestring nullable

The company that created this audience.

created_timestampinteger nullable

Creation time. Unix timestamp in seconds.

descriptionstring nullable

Audience description.

idstring required

Audience ID.

is_ncaboolean

Whether the audience derives from a new customer acquisition (expanded matching) customer list. Read-only.

namestring

Audience name.

sizeinteger nullable

Audience size.

Audience processing status

typestring

Always "audience".

updated_timestampinteger nullable

Last update time. Unix timestamp in seconds.

Example response

{
  "audience_type": "ACTALIKE",
  "rule": {
    "event_data": {
      "lead_type": "Newsletter",
      "line_items": {
        "product_brand": "Parker",
        "product_category": "Shoes",
        "product_id": 1414,
        "product_name": "Parker Boots",
        "product_price": "99.99",
        "product_quantity": 2,
        "product_variant": "Red",
        "product_variant_id": "1414-34832"
      },
      "order_id": "X-151481",
      "order_quantity": 1,
      "page_name": "Our Favorite Pins on Pinterest",
      "promo_code": "WINTER10",
      "property": "Athleta",
      "search_query": "boots",
      "value": "199.98",
      "video_title": "How to style your Parker Boots"
    }
  }
}