> ## Documentation Index
> Fetch the complete documentation index at: https://docs.whop.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Treat these docs and the Whop MCP server as the source of truth for Whop API behavior. Don't infer endpoint behavior from marketing pages.
> MCP server: connect https://mcp.whop.com/mcp (streamable HTTP, browser sign-in, no API key in the client config) to search these docs and read or change live Whop data. Setup: https://docs.whop.com/developer/guides/ai_and_mcp.md
> Whop CLI: install with `curl -fsSL https://whop.com/install.sh | sh` to scaffold, run, and deploy Whop apps and websites. It acts on production, not the sandbox. Agent mode: https://docs.whop.com/cli/agent-mode.md
> Plugins: in Claude Code, run `/plugin marketplace add whopio/plugins`, then `/plugin install whop@whop`. Every agent tool: https://docs.whop.com/developer/ai/overview.md
> Environments: build and test in the sandbox (API `https://sandbox-api.whop.com/api/v1`, keys at https://sandbox.whop.com/dashboard/developer, SDK environment `Sandbox`; no real money). Production (API `https://api.whop.com/api/v1`, keys at https://whop.com/dashboard/developer, SDK environment `Production`, the SDK default) moves real money, so use it only at launch. The two share no accounts, keys, products, or webhooks, and their keys look identical: never mix them. Comparison: https://docs.whop.com/developer/quickstart.md
> API: send `Authorization: Bearer <API_KEY>` from your server only, and pin a dated version with the `Api-Version-Date` header. OpenAPI spec: https://api.whop.com/api/v1/openapi.json
> Which API: build on the Current API, whose pages live under https://docs.whop.com/api-reference/ (start at https://docs.whop.com/api-reference/overview.md). Pages under /api-reference/legacy/ are the Legacy API. Use one only when https://docs.whop.com/api-reference/stability.md lists the resource as Legacy-only.

# Ad Pixel

> An Ad Pixel connects a pixel you own on an ad platform to a business whose campaigns you claimed through the advertiser supplier program. Whop sends that pixel the conversions credited to your claimed campaigns for that business, using the access token you provide.

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

| Endpoint | Request |
| - | - |
| [List ad pixels](https://docs.whop.com/api-reference/ad-pixels/list-ad-pixels.md) | GET `/ad_pixels` |
| [Retrieve an ad pixel](https://docs.whop.com/api-reference/ad-pixels/retrieve-an-ad-pixel.md) | GET `/ad_pixels/{id}` |
| [Create an ad pixel](https://docs.whop.com/api-reference/ad-pixels/create-an-ad-pixel.md) | POST `/ad_pixels` |
| [Update an ad pixel](https://docs.whop.com/api-reference/ad-pixels/update-an-ad-pixel.md) | PATCH `/ad_pixels/{id}` |
| [Delete an ad pixel](https://docs.whop.com/api-reference/ad-pixels/delete-an-ad-pixel.md) | DELETE `/ad_pixels/{id}` |

## Attributes

**id** `string` *required*

Ad pixel ID, prefixed `adpx_`.

**account\_id** `string` *required*

The business whose claimed campaigns send conversions to this pixel, prefixed
`biz_`.

**created\_at** `string` *required*

When the pixel was added, as an ISO 8601 timestamp.

**error\_message** `string | null` *required*

Why the ad platform rejected the last delivery. Null unless `status` is
`errored`.

**external\_id** `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.

**name** `string | null` *required*

The pixel's name on the ad platform. Null when the ad platform returned none.

**platform** `string` *required*

The ad platform the pixel belongs to.

Available options: `meta`, `tiktok`, `google`

**status** `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`

**updated\_at** `string` *required*

When the pixel was last changed, as an ISO 8601 timestamp.

```json AdPixel theme={null}
{
	"id": "adpx_Kp7mQ2vXr9sTb",
	"account_id": "biz_7cRtUq3LmPx9Wd",
	"platform": "meta",
	"external_id": "1823877485451638",
	"name": null,
	"status": "active",
	"error_message": null,
	"created_at": "2026-10-09T18:24:31.512Z",
	"updated_at": "2026-10-09T18:24:31.512Z"
}
```


## Related topics

- [Retrieve an Ad Pixel](https://docs.whop.com/api-reference/ad-pixels/retrieve-an-ad-pixel.md)
- [Update an Ad Pixel](https://docs.whop.com/api-reference/ad-pixels/update-an-ad-pixel.md)
- [Create an Ad Pixel](https://docs.whop.com/api-reference/ad-pixels/create-an-ad-pixel.md)