Meta Ads

Add users to a customer-list audience by uploading hashed personal data. Requires custom_audience_id (from list_custo…

Cancel (delete) an ad study by id. Use list_ad_studies to find study ids. This is the inverse of create_ad_study.

Connect one or more event sources (pixels, apps, offline sets) to a catalog for signal matching. Requires catalog_id…

Create an ad in an ad set. Requires account_id (from list_ad_accounts), name, adset_id (from list_ad_sets), creative…

Create an ad creative under an ad account. Requires account_id (from list_ad_accounts) and name; optionally title, bo…

Create an ad set under a campaign. Requires account_id (from list_ad_accounts), name, campaign_id (from list_campaign…

Create an ad study (A/B test or conversion lift). Requires business_id (numeric id from Business settings, NOT an ad…

Create a campaign under an ad account. Requires account_id (from list_ad_accounts), name, objective, special_ad_categ…

Create a custom audience. Requires account_id (from list_ad_accounts) and name; a CUSTOM (customer-file) audience als…

Create a supplementary rule that maps or transforms an attribute on a feed. Requires feed_id (from list_product_feeds…

Start an upload session that fetches a feed file from a URL. Requires feed_id (from list_product_feeds) and url; set…

Add a product to a catalog. Requires catalog_id (from list_product_catalogs), retailer_id (your SKU), name, price (in…

Create a product catalog under a Business Manager. Requires business_id (numeric id from Business settings) and name…

Register a product feed on a catalog. Requires catalog_id (from list_product_catalogs) and name; optionally feed_type…

Create a product set in a catalog. Requires catalog_id (from list_product_catalogs) and name; optionally a structured…

Delete an ad by id. Use list_ads to find ad ids. This removes the ad and stops its delivery.

Delete an ad creative by id. Use list_ad_creatives to find creative ids.

Delete an ad set by id. Use list_ad_sets to find ad set ids. This removes the ad set and stops delivery of its ads.

Delete a campaign by id. Use list_campaigns to find campaign ids. This removes the campaign and its delivery.

Delete a custom audience by id. Use list_custom_audiences to find audience ids. Inverse of create_custom_audience.

Delete a feed transformation rule by id without affecting the feed or products. Use list_feed_rules to find rule ids…

Delete a product from a catalog by id. Use list_products to find product ids. Inverse of create_product.

Delete a product feed and its schedule by id; products it supplied are removed asynchronously. Use list_product_feeds…

Delete a product set by id; products remain in the catalog. Use list_product_sets to find ids. Set allow_live_product…

Disconnect one or more event sources from a catalog to stop signal matching. Requires catalog_id (from list_product_c…

Render a preview of an ad or creative in a specific placement (Feed, Story, Reels, etc.). Requires account_id (from l…

Get a single ad study by id, with type, status, cells, and results. Works for both A/B tests and lift studies. Use li…

Get a single campaign by id, with status, objective, and budgets. Use list_campaigns to find campaign ids.

Get a single custom audience by id, with size, status, and subtype. Use list_custom_audiences to find audience ids.

Get a dataset (pixel) node: metadata, Conversions API configuration, and pixel settings. Use list_datasets to find pi…

Get a dataset’s event volume over a time window, optionally broken down by device or event source. Use list_datasets…

Get a single product by id, with name, price, availability, and imagery. Use list_products to find product ids.

Get a single product catalog by id, with name, vertical, product/feed counts, and owning business. Use list_product_c…

Get a single product feed’s configuration by id: URL, schedule, format, and status. Use list_product_feeds to find fe…

Get a single product set by id, with its filter rule and match count. Use list_product_sets to find product set ids.

List activity log entries for an ad account (who changed what, when). Pass account_id from list_ad_accounts. Filter b…

List the ad accounts the token can access, with id (act_number), name, currency, and balance. Start here to get an ac…

List ad creatives under an ad account, each with its id for attaching to a new ad. Pass account_id from list_ad_accou…

List ad images uploaded to an ad account, each with its hash (used to reference it in a creative). Pass account_id fr…

List ad sets under an ad account, each with its campaign_id for client-side scoping. Pass account_id from list_ad_acc…

List the ad studies (A/B tests and lift studies) that impact an ad account. Pass account_id from list_ad_accounts. Pa…

List ad videos uploaded to an ad account, each with id, title, and length. Pass account_id from list_ad_accounts. Fil…

List ads under an ad account, each with its adset_id and campaign_id for client-side scoping. Pass account_id from li…

List campaigns under an ad account, with status, objective, and budgets. Pass account_id from list_ad_accounts. Filte…

List the data sources (feeds, uploads, API sources) attached to a product catalog. Use list_product_catalogs to find…

List diagnostics (errors, warnings, opportunities) on a product catalog that may affect ad delivery. Use list_product…

List the event sources (pixels, apps, offline conversion sets) connected to a product catalog. Pass catalog_id from l…

List custom audiences on an ad account, each with name, subtype, and approximate size. Pass account_id from list_ad_a…

List custom conversions defined on an ad account, each with name, rule, and event type. Pass account_id from list_ad_…

List datasets (pixels) on an ad account, each with name and last-fired time. Pass account_id from list_ad_accounts. P…

List the supplementary rules applied to a product feed. Pass feed_id from list_product_feeds. Page with limit + after.

List upload sessions for a product feed, with status and error counts. Pass feed_id from list_product_feeds. Page wit…

List Instagram Business/Creator accounts linked to an ad account, each with id and username. Pass account_id from lis…

List recent media (posts, reels, stories) on an Instagram Business/Creator account. Pass ig_user_id from list_instagr…

List product catalogs owned by a Business Manager, with name, vertical, and product count. Pass business_id (the nume…

List the product feeds registered on a catalog, each with name and product count. Pass catalog_id from list_product_c…

List the products contained in a product set. Use list_product_sets to find product set ids. Page with limit + after.

List product sets in a catalog, each with name and product count. Pass catalog_id from list_product_catalogs. Page wi…

List or search products in a product catalog. Pass catalog_id from list_product_catalogs. Pass a structured filter ob…

List the Facebook Pages that have been used for ads on an ad account, each with id and name. Pass account_id from lis…

Remove users from a customer-list audience by uploading hashed personal data to match. Requires custom_audience_id (f…

Search the public Meta Ad Library for competitive research. Requires ad_reached_countries and at least one of search_…

Send server events to a dataset via the Conversions API (POST //events). Requires pixel_id (from list_datasets) and d…

Edit an existing ad study’s name, description, end time, or cells. Use list_ad_studies to find study ids. To cancel a…

Update a campaign by id (Meta uses POST, not PATCH). Change name, status, budgets, bid_strategy, or special_ad_catego…

Update a custom audience’s name, description, or website rule. Use list_custom_audiences to find audience ids. Meta u…

Update a dataset (pixel) setting: name, automatic advanced matching, or data-use. Use list_datasets to find pixel ids…

Update a product’s fields (name, price, availability, brand, imagery). Use list_products to find product ids. Meta us…

Update a product catalog’s name or default/fallback image URLs. Use list_product_catalogs to find catalog ids. Meta u…

Update a product feed’s name, currency default, or fetch schedules. Use list_product_feeds to find feed ids. Meta use…

Update a product set’s name, filter, or retailer id. Use list_product_sets to find product set ids. Meta uses POST (n…