Create audience
POST {{baseUrl}}/ad_accounts/:ad_account_id/audiences
This endpoint is currently in beta and not available to all apps. Learn more.
Create an audience you can use in targeting for specific ad groups. Targeting combines customer information with the ways users interact with Pinterest to help you reach specific groups of users; you can include or exclude specific audienceids when you create an ad group.
For more, see <a class=reference external
href=https://help.pinterest.com/en/business/article/audience-targeting
target="blank">Audience targeting.
Request Body
{"audience_type"=>"ACTALIKE", "name"=>"string", "rule"=>{"country"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "customer_list_id"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "engagement_domain"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "engagement_type"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "event"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "event_data"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "percentage"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "pin_id"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "prefill"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "retention_days"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "seed_id"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "url"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "visitor_source_id"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "event_source"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "ingestion_source"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "engager_type"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "campaign_id"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "ad_id"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "objective_type"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "ad_account_id"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "ad_account_id"=>"549755885175", "description"=>"string"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"ad_account_id":"549755885175","id":"1234","name":"ACME Tools","audience_type":"ea nulla et anim","description":"People who love making quilts.","rule":{"country":"US","customer_list_id":"5497558859876","engagement_domain":["www.somedomain.com"],"engagement_type":"click","event":"checkout","event_data":{"currency":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"lead_type":"Newsletter","line_items":{"product_brand":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"product_category":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"product_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"product_name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"product_price":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"product_quantity":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"product_variant":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"product_variant_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"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"},"percentage":30,"pin_id":["34567"],"prefill":true,"retention_days":30,"seed_id":["2542620639259","2542620639261"],"url":["ad","quis nulla enim"],"visitor_source_id":"549755885175","event_source":{"=":["web","mobile"]},"ingestion_source":{"=":["tag"]},"engager_type":1,"campaign_id":["626744528398"],"ad_id":["687201361754"],"objective_type":["AWARENESS"],"ad_account_id":"549755885175"},"size":1000,"status":"ut","type":"audience","created_timestamp":1451431341,"updated_timestamp":1451431341}