Facebook Ads

Documentation for Ad-publishing API

📄️ Search targeting options

Search Facebook geo-locations and interests for ad targeting

📄️ Publish campaign

Publish a Facebook campaign and push it live to Facebook

📄️ Get conversion pixels

Retrieve Facebook conversion pixels for a location. For the FACEBOOK channel, without `limit` the response is `{ items, total }`; when `limit` is provided (max 100) the response is a paginated `{ items, paging }` envelope — pass `after` (from `paging.next`) to fetch the next batch. By default each item is returned in full; pass `projection` (comma-separated) to return only the requested fields, chosen from `createdAt`, `fbIsCrmPixel`, `fbPixelCode`, `fbPixelId`, `name`, `type` (any other value is rejected).

📄️ Upsert conversion pixel

Create or update a Facebook conversion pixel configuration

📄️ Get custom audiences

Retrieve Facebook custom audiences for a location. Without `limit` the response is a plain array. When `limit` is provided (max 100) the response is a paginated `{ customAudiences, paging }` envelope; pass `after` (from `paging.next`) to fetch the next batch. By default each item is returned in full; pass `projection` (comma-separated, dot-notation for nested fields, e.g. ?projection=id,name,dataSource.type) to return only the requested fields — any value outside the known field set is rejected.

📄️ Delete custom audience

Delete a Facebook custom audience by ID

📄️ Update custom audience

Update name or description of a Facebook custom audience

📄️ Get custom audience by ID

Retrieve a specific Facebook custom audience by its ID

📄️ Add custom audience member

Add a member to a Facebook custom audience

📄️ Remove custom audience member

Remove a member from a Facebook custom audience

📄️ Batch update audience members

Add or remove members in bulk from a Facebook custom audience via CSV or smart lists

📄️ Get campaign with linked entities

Retrieve a Facebook campaign with its linked adsets and ads

📄️ Get entities

Retrieve Facebook campaigns, adsets, or ads based on entity type

📄️ Upsert campaign

Create or update a Facebook campaign

📄️ Upsert adset

Create or update a Facebook ad set

📄️ Upsert ad

Create or update a Facebook ad

📄️ Pause campaign

Pause a running Facebook campaign

📄️ Resume campaign

Resume a paused Facebook campaign

📄️ Duplicate campaign

Duplicate an existing Facebook campaign

📄️ Delete campaign

Delete a Facebook campaign by ID

📄️ Pause ad set

Pause a running Facebook ad set

📄️ Resume ad set

Resume a paused Facebook ad set

📄️ Duplicate ad set

Duplicate an existing Facebook ad set

📄️ Delete ad set

Delete a Facebook ad set by ID

📄️ Pause ad

Pause a running Facebook ad

📄️ Resume ad

Resume a paused Facebook ad

📄️ Duplicate ad

Duplicate an existing Facebook ad

📄️ Delete ad

Delete a Facebook ad by ID

📄️ Get campaign publishing progress

Returns Redis-backed publish progress for a campaign while it is publishing to Meta. Used by the validation funnel UI to poll step counts and completion state.