Build with us

Resources

Developer centers

Ads and Commerce

Ads and Commerce

Marketing API Overview

About Marketing API

Data Processing Options

Get Started with Marketing API

Ad Creation Guides

Basic Ad Creation

Create an Ad Campaign

Create an Ad Set

Create an Ad Creative

Manage Campaigns

Ad Performance & Optimization

Optimization Basics

Monitoring and Analytics

Optimization Tips

Introduction to Ad Creatives

Video & Carousel Ads

Video & Carousel

Instant Experiences

Lead Ads Guides

Quality Features

Testing and Troubleshooting

Advantage+ Catalog Ads for Leadgen

CRM Integration

Instagram Ads Guides

Instagram Ads API

Setup & Management

Set Up Instagram Accounts On Business Manager

Set Up Instagram Accounts With Pages

Ads With Mixed Placements

Add Call-To-Action

Get Ad Insights

Use Posts as Instagram Ads

Instagram Advantage+ Catalog Ads

Post Moderation

Use URL Tags for Tracking

Customize Stories

Add Interactive Elements

Requirement Guides

Media Requirements

Data and Call To Action Requirements

Threads Ads Guides

Threads Ads Creation

Advantage+ Catalog Ads

Use Posts as Ads

Reply Moderation

Threads Ads Insights

Messaging Ads Guides

Click to Messenger

Click to Instagram

Click to WhatsApp

Multidestination

Website Ads Click to Message

Multi-Media Ads

Partnership Ads

Partner Permissions

Post-Level Permissioning

Account-Level Permissioning

Partnership Ads Creation

Instagram Partnership Ads

Boost Existing Instagram Media as Partnership Ads

Instagram Partnership Ads with a New Ad Creative

Supported Partnership Ads Configurations

Supported Configurations

Placement Asset Customization

Advantage+ Creative

Click To Message Destinations

Advantage+ Catalog Ads

Testimonial Ads

Lead Generation Ads

Facebook Partnership Ads

Boost Existing Facebook Posts as Partnership Ads

Facebook Partnership Ads with a New Ad Creative

Partnership Ad Codes

Branded Content

Create Branded Content

Manage Branded Content Permissions

Event and Local Ads

Advantage+ Campaigns

Advantage+ Shopping Campaign Guides

Advantage+ Shopping Campaign API

Cross-Channel Conversion Optimization

Audience Type URL Parameters

Asset Feed Spec Guides

Asset Feed Spec

Asset Feed Options

Dynamic Creative

Customization Rules

Asset Customization Rules

Placement Asset Customization

Multi-Language Ads

Advantage+ Catalog Ads Guides

Advantage+ Catalog Ads

Advantage+ Catalog Ads Mobile

Advantage+ App Campaigns

Allow Product Video Guides

Allow product video

Multi-Aspect Ratio Images

Advantage+ Creative for Catalog

Real Estate Ads Guides

Real Estate Ads

Audiences & Management

Travel Ads Guides

Travel Ads - Audience Management

Hotel Ads Guides

Hotel Ads - Catalog & Feed

Hotel Ads - Events

Hotel Ads - Template Tags

Hotel Ads - Date-Specific Prices

Flight Ads Guides

Flight Ads Catalog & Feed

Flight Ads - Template Tags

Destination Ads Guides

Destination Ads

Destination Catalog

Destination Events

Destination Ads - Template Tags

Automotive Ads Guides

Automotive Ads Management

Automotive Inventory Ads

Automotive Model Ads

Audience Management

Advantage+ Catalog Ads with an On-Facebook Destination

Advantage+ Creative Guides

Advantage+ Creative

Product Extensions for Advantage+ Creative

Standard Enhancements for Advantage+ Creative

Advantage+ Creative Preview API

Omnichannel Ads

Generative AI Features

Collaborative Ads Guides

Collaborative Ads

Managed Partner Ads Guides

Managed Partner Ads

Prerequisites & System Users

Create Admin System User

Assign Permissions to System User

Generate Access Token for System User

Seller Management Guides

Seller Management

Check Seller Eligibility

Onboard a Seller

Delete a Seller

Partner Ads Management Guides

Partner Ads Management

Async API User Guide

Error Handling Guide

Partner Premium Options

Multi-advertiser Ads

Call Ads Guides

Callback Feeature

Flexible Ad Format

Format Automation

Budget & Strategy

Pacing and Scheduling

Bidding & Optimization

Advantage Campaign Budget

Ad Set Budget Sharing

Optimized Cost Per Mille Ads

Cost Per Action Ads

Bid Multipliers

Cross-Channel Conversion Optimization

Ad Rules Engine Guides

Ad Rules Engine

Evaluation Spec

Trigger Based Rules

Schedule Based Rules

Advanced Scheduling

Evaluation Spec Filters

Rebalance Budget

Audience Guides

Customer File Custom Audiences

Lookalike Audiences

Value-Based Lookalikes

Engagement Custom Audiences

Mobile App Custom Audiences

Website Custom Audiences

Offline Custom Audiences

Dynamic Audiences

Audience Network Ads

Reach Estimate API

Special Ad Category

Targeting Guides

Basic Targeting

Advanced Targeting

Placement Targeting

Targeting Search

Detailed Targeting

Targeting Description

Advantage Targeting Guides

Advantage Targeting

Advantage+ Audience

Advantage Detailed Targeting

Advantage Lookalike

Advantage Custom Audience

Flexible Targeting

Deprecated Targeting Terms

Targeting Restrictions

Estimated Daily Results

Custom Audience Terms Of Service

Limits & Best Practices

Tracking and Conversion Specs

Marketing Mix Modeling

Conversion Lift Measurement

Brand Safety and Suitability Guides

Brand Safety and Suitability

Integration Setup

Publisher Block Lists API

Content Block Lists API

Content Delivery Reports API

Feed Verification API

Publisher Delivery Reports API

Partner-publisher Lists API

Best Practices & Recommendations

Performance Recommendations API

Performance Recommendations History API

Omni Optimal Setup Guide

Manage Your Ad Object's Status

Async and Batch Requests

Post-Processing for Ad Creation

Troubleshooting

Standard Error Codes

iOS 14 Error Codes

Version Changelogs

Out-of-Cycle Change Index

Out-of-Cycle Changes

Conversions API

Conversions API Overview

Verifying Setup

Main Body Parameters

Server Event Parameters

Customer Information Parameters

Customer Information Parameters

fbp and fbc Parameters

Standard Parameters

App Data Parameters

Original Event Data

Parameter Builder Library

Parameter Builder Library

Workflow and Examples

Conversions API for App Events

Conversions API for Offline Events

Conversions API for Business Messaging

Conversion Leads Integration

Conversion Leads Integration

1: Connecting Your CRM to Download Leads

2: Getting Started with Integration

3: Developer Implementation

3: Zapier Implementation

3: Zapier Implementation

Step 1: Implement Integration

Step 2: Verify Integration

4: Verify Your Data

5: Configure Your Sales Funnel

6: Follow-up Steps

Payload Specification

Find the Lead ID

Dataset Quality API

Dataset Quality API

Dataset Quality API for Offline Events

Handling Duplicate Events

End-to-end Implementation

Conversions API as a Platform

Zapier Integration

Conversions API for Google Tag Manager

Conversions API for CRM for Platforms

Set Up Conversions API with Salesforce Webhooks

Business SDK Features for Conversions API

Append Attribution

Integration Guidance: Value Optimization

Conversions API Gateway

Conversions API Gateway

Getting Started

DNS Setup Guide

Post-Setup Management

Non-Web Server Events API Support

System Health Information

Enhance Events with Advanced Matching Data

Include Facebook Login Data in the Conversions API

Troubleshooting Tools

Troubleshooting Guide

Uninstall Guide

Conversions API Gateway: AWS App Runner

Conversions API Gateway: AWS App Runner

Cost Monitoring

Custom Domain Setup

Scaling Control

Automatic and Manual Updates

Uninstall Guide

Conversions API Gateway for Multiple Accounts

Conversions API Gateway for Multiple Accounts

Host Onboarding: AWS EKS

Host Onboarding: AWS EKS

1. Create Instance

2. Configure a Host Account

3. Set Up Custom Domain

Host Onboarding: AWS App Runner

Host Onboarding: AWS App Runner

1. Create Instance

2. Configure a Host Account

3. Set Up Custom Domain

Host Onboarding: GCP

Host Onboarding: GCP

1. Create Instance

2. Create a Custom Domain

3. Set Auto-Scaling Limits

Host Management

Host Management

Host User Management

Managing Hosted Accounts

Set Up SMTP Configuration

Account Onboarding and Management

Account Onboarding and Management

Onboarding and Offboarding Unmanaged Accounts

User Management for Hosted Accounts

Data Source Management

Manage Domain Allow and Block Lists

Configure Data Routing for Hosted Accounts

AWS EKS Architecture

AWS App Runner Architecture

GCP Architecture

Monitoring Your Setup

Prospective Agencies: FAQs

Troubleshooting Tools

Troubleshooting Guide

Uninstall Guide

Conversions API Gateway for Multiple Accounts Control Plane API

Conversions API Gateway for Multiple Accounts Control Plane API

Account Management

User Management

Pixel Management

Account Data Routing Configuration

Account Event Metrics

Troubleshooting

Conversions API Gateway and Signals Gateway

Gateway Products Overview

Conversions API Gateway

Conversions API Gateway

Instance Activation

Enhance Events With Additional User Data

Include Facebook Login Data in the Conversions API

Monitor Your Setup

Data Source Management

Uninstall Guide

Signals Gateway

Signals Gateway

Instance Activation

Pipeline Management

Data Source Management

Data Destination Management

Custom Data Destination

Event Filtering

Diagnostics Tab

Temporary User Creation for Debugging

Signals Gateway Pixel Onboarding

Signals Gateway Pixel Setup in Google Tag Manager

Signals Gateway SDK Onboarding

Signals Gateway Pixel Helper

Google BigQuery Connection Setup

Custom Audience

Enable CDN Domains

Host Management

Host Management

Post-Setup Management

Account Management

Account Management

Onboarding and Offboarding Unmanaged Hosted Accounts

Manage Domain Allow-Lists and Block-Lists

Host User Management

Set Up SMTP Configuration

Set Auto-Scaling Limits

System Health Information

DNS Setup Guide

Conversions API Gateway Pipeline

Conversions API Gateway Pipeline

Advanced Matching

Include Facebook Login Data

Control Plane API

Control Plane API

Account Management

User Management

Pixel Management

Account Data Routing

Account Event Metrics

Set Up Data Pipelines

Set Up Data Pipelines

Data Destinations

Create an Instance: Agencies and Partners

Create Instance From Events Manager

GCP Architecture

Create Custom Domain for GCP

AWS EKS Onboarding

AWS ECS Express Onboarding

AWS ECS Express Onboarding

AWS ECS Express Architecture

Custom Domain Setup

Cost Monitoring

Troubleshooting Guide

Sending Events From a Server

Uninstall Guide

Supported Products and Services

Catalog Integration Using Meta Business SDK

Catalog Item Types

Manage Catalog Items

Manage Catalog Items

Catalog Batch API

Catalog Batch API

Migrate to the Items Batch Endpoint

Catalog and Signals Quality

Product Variants

Product Categories

Product Deep Links

Supplementary Feeds

Diagnostics API

Localized Catalogs

Localized Catalog Setup

Localized Catalog Setup

Localized Catalog Supported Fields

Localized Catalog for Advantage+ Catalog Ads

Localized Catalog for Instagram Shopping

Generic Feed Files API

Commerce Merchant Settings API

Ratings and Reviews API

Page Owned Catalog API

Media Titles Catalog Edge

Media Titles Product Set Edge

Media Titles Feed Edge

Apps and Software

Apps and Software

Apps and Software Catalog Edge

Apps and Software Product Set Edge

Apps and Software Feed Edge

Articles and Publications

Articles and Publications

Articles and Publications Catalog Edge

Articles and Publications Product Set Edge

Articles and Publications Feed Edge

Professional Services

Professional Services

Professional Services Catalog Edge

Professional Services Product Set Edge

Professional Services Feed Edge

Activities Catalog Edge

Activities Product Set Edge

Activities Feed Edge

Commerce Platform

User Experience

Payment and Data Flows

Accounts and Assets

API Integration Setup

Seller Integration

Partner Integration

Partner Integration Basics

Onboarding Integration

Catalog Integration

Build Offers Integration

Order Integration

Platform Integration

Onboarding Integration for FBE

Commerce Manager Redirect Onboarding

Page Eligibility for Commerce

Troubleshooting

Merchant Distribution for MP/IG

Merchant Distribution for MP/IG

Marketplace Approval API

Merchant Support

Validate the Integration

Product Review Feed Schema

Feed Schema CSV

Automate Ratings and Reviews Seller Analysis

Migrate to Simplified Shops Ads API

Set Up Checkout URL

Enable Subscriptions

Shops Ads Lightweight BOPIS Experience

Shops Ads Heavyweight BOPIS Experience

Catalog and Inventory

Product Catalog

disabled_capabilities

Product Categories

Product Categories

Clothing, Shoes & Accessories

Home Decor & Furniture

Jewelry & Watches

Health & Beauty

GPC-to-FPC Mappings

Product Variants

Collections API

Commerce Merchant Settings

Quantity to Sell

Feed API Reference

Supplementary Feeds

Batch API Reference

Localized Catalog for Instagram Shopping

Updating Ads Catalog

Multi-Platform Catalog Management

Update-Only Shopify Feed

Flexify Integration Guide

Order Management

Order Lifecycle

Acknowledgement API

Order Snapshot API

Fulfillment API

Cancellation and Refund API

Legacy API Reference

Shipping Profiles API Reference

Associate Shipping Profiles with Products

Shipping Carrier Codes

Finance Reporting

Finance and Tax

Plan Your Integration

Commerce Integration - Platform Partners

Shipping and Fulfillment

Customer Communication

Ads AI Connectors

Command reference

Datasets and catalogs

Tutorials and recipes

Resources

Adrules Governed

Facebook Feedback

Targetingsentencelines

Aaa Compatible Ad Objects

Account Controls

Ad Column Sizes

Ad Custom Derived Metrics

Ad Place Page Sets

Ad Place Page Sets Async

Adrules Count By Type

Adrules Library

Ads Reporting Mmm Reports

Ads Reporting Mmm Schedulers

Applied Publisher Block Lists

Async Batch Requests

Asyncadcreatives

Asyncadrequestsets

Broadtargetingcategories

Campaign Attribution Options

Collaborative Ads Partner Businesses

Connected Instagram Accounts

Customaudiences

Customaudiencestos

Customconversions

Delivery Estimate

Deprecatedtargetingadsets

Dsa Recommendations

Generatepreviews

Impacting Ad Studies

Instagram Accounts

Locationclusters

Mcmeconversions

Message Delivery Estimate

Minimum Budgets

Naming Templates

Offline Conversion Data Sets

Optimization Goals Aemv2 Eligibility

Product Audiences

Publisher Block Lists

Reachfrequencypredictions

Saved Audiences

Smart Suggested Ads

Start Your Day Widgets

Subscribed Apps

Targetingbrowse

Targetingsearch

Targetingsuggestions

Targetingvalidation

Urls For Asset Extraction

Website Creative Assets

Website Creative Info

Youth Ads Advertiser

Ad Account User

Creative Insights

Adrules Governed

Budget Schedules

Ad Preview Plugin

Ad Promoted Object

Adrules Governed

Asyncadrequests

Budget Schedules

Budget Split Set

Campaign Actions

Delivery Estimate

Message Delivery Estimate

Publisher Delivery Report

Targeting Insights

Targetingsentencelines

Continuous Lift Config

Related Ad Accounts

Ads Signal Diagnostic Issues

Analytics Entity User Config

Analytics Funnel Query

Analytics Segments

Capability Overrides

Cloudbridge Dataset Status

Cpas Events Debugging Info

Customconversions

Domain Control Rule

Domain Last Fired Time

Event Last Fired Time

Integration Quality

Item Price Stats

Microdata Stats

Openbridge Configurations

Pixel Delivery Recommendations

Real Time Event Log

Server Events Permitted Business

Shared Accounts

Shared Agencies

Signals Iwl Feedback Nux

Signals Iwl Nux

Add Phone Numbers

Adnetworkanalytics

Adnetworkanalytics Export

Adnetworkanalytics Results

Ads Custom Pivots Preview

Ads Reporting Exports

Ads Reporting Mmm Reports

Ads Reporting Mmm Schedulers

An Publisher Blocklist Apps

An Publisher Blocklist Categories

An Publisher Blocklist Domains

An Publisher Blocklist Pages

Applied Publisher Block Lists

Business Asset Groups

Business Invoices

China Business Onboarding Attributions

Claim Custom Conversions

Client Ad Accounts

Client Business Asset Groups

Client Instagram Accounts

Client Instagram Assets

Client Offsite Signal Container Business Objects

Client Product Catalogs

Client Publisher Block Lists

Client Whatsapp Business Accounts

Collaborative Ads Collaboration Requests

Collaborative Ads Suggested Partners

Commerce Merchant Settings

Content Block Lists

Creative Asset Tags

Creative Folders

Customconversions

Event Source Groups

Extendedcredits

Finance Permissions

Ig Bc Ad Permissions

Initiated Audience Sharing Requests

Initiated Sharing Agreements

Instagram Accounts

Instagram Business Accounts

Managed Businesses

Managed Partner Ads Funding Source Details

Managed Partner Businesses

Measurement Reports

Offline Conversion Data Sets

Openbridge Configurations

Owned Ad Accounts

Owned Businesses

Owned Custom Conversions

Owned Instagram Accounts

Owned Instagram Assets

Owned Offsite Signal Container Business Objects

Owned Product Catalogs

Owned Publisher Block Lists

Owned Whatsapp Business Accounts

Parent Advertiser Infos

Partner Account Linking

Partner Center Export Files

Partner Relationships

Pending Client Ad Accounts

Pending Client Apps

Pending Client Pages

Pending Offline Conversion Data Sets

Pending Owned Ad Accounts

Pending Owned Pages

Pending Shared Offsite Signal Container Business Objects

Pending Shared Pixels

Preverified Numbers

Publisher Block Lists

Received Audience Permissions

Received Audience Sharing Requests

Received Inprogress Onbehalf Requests

Received Inprogress Transfer Ownership Agreements

Received Sharing Agreements

Reseller Events

Reseller Guidances

Resellervettingrequests

Salesrights Inventory Management

Self Certified Whatsapp Business Submissions

Self Certify Whatsapp Business

Sent Inprogress Onbehalf Requests

Share Preverified Numbers

Shared Audience Permissions

Sso Migrated Business Users

Sso Unmigrated Business Users

System User Access Tokens

Third Party Partner Lift Requests

Third Party Partner Panel Recurring Requests

Third Party Partner Panel Requests

Third Party Partner Viewability Requests

Whatsapp Business Accounts

Business Role Request

Assigned Client Assets

Assigned Owned Assets

Assigned Ad Accounts

Assigned Ads Pixels

Assigned Business Asset Groups

Assigned Creative Folders

Assigned Instagram Accounts

Assigned Monetization Properties

Assigned Offline Conversion Data Sets

Assigned Product Catalogs

Assigned Whatsapp Business Accounts

Custom Audience Targeting

Shared Account Campaign Info

Shared Account Info

High Demand Period

Product Catalog

Additional Reviews

Automotive Models

Catalog Segments

Check Batch Request Status

Check Marketplace Partner Sellers Status

Collaborative Ads Share Settings

Connected Businesses

Dpa Eligible Ad Accounts

External Event Sources

Hotel Rooms Batch

Local Service Businesses

Localized Items Batch

Marketplace Partner Signals

Pricing Variables Batch

Product Sets Batch

Smart Pixel Settings

Update Generated Image Config

Assigned Ad Accounts

Assigned Ads Pixels

Assigned Business Asset Groups

Assigned Creative Folders

Assigned Instagram Accounts

Assigned Monetization Properties

Assigned Offline Conversion Data Sets

Assigned Product Catalogs

Assigned Whatsapp Business Accounts

Conversions API Gateway

Conversions API Gateway

Updated: Feb 3, 2025

This content has moved!

We have moved this content to the “Gateway Products” section of the site.

Go to: Conversions API Gateway

Meta

Instagram

YouTube

Build with Meta

AI Meta Horizon Social technologies Wearables

News

Meta for Developers Blog Success stories

Support

Developer Support Bug tool Platform status Developer community forum Report an incident

Terms and policies

Responsible platform initiatives Platform terms Developer policies Privacy policy Cookies

About us

Build with Meta

Social technologies

News

Meta for Developers

Success stories

Support

Developer Support

Platform status

Developer community forum

Report an incident

About us

Terms and policies

Responsible platform initiatives

Developer policies

Build with Meta

Social technologies

News

Meta for Developers

Success stories

Support

Developer Support

Platform status

Developer community forum

Report an incident

About us

Terms and policies

Responsible platform initiatives

Developer policies

Build with Meta

Social technologies

News

Meta for Developers

Success stories

Support

Developer Support

Platform status

Developer community forum

Report an incident

About us

Terms and policies

Responsible platform initiatives

Developer policies

English (US)