Skip to main content
Use the Ad Pixels API to add one pixel per business on each ad platform, list or retrieve your pixels, replace an access token the ad platform rejected, and remove a pixel to stop deliveries.

Endpoints

Attributes

string
required
Ad pixel ID, prefixed adpx_.
string
required
The business whose claimed campaigns send conversions to this pixel, prefixed biz_.
string
required
When the pixel was added, as an ISO 8601 timestamp.
string | null
required
Why the ad platform rejected the last delivery. Null unless status is errored.
string
required
The pixel’s ID on the ad platform: the Meta pixel or dataset ID, the TikTok pixel code, or the Google Ads customer ID.
string | null
required
The pixel’s name on the ad platform. Null when the ad platform returned none.
string
required
The ad platform the pixel belongs to.Available options: meta, tiktok, google
string
required
active receives conversions. errored stopped because the ad platform rejected the access token; update the token to resume. disabled was turned off by Whop.Available options: active, errored, disabled
string
required
When the pixel was last changed, as an ISO 8601 timestamp.
AdPixel