> ## 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.

# 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, 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](/api-reference/beta/ad-pixels/list-ad-pixels) | <Badge color="blue" size="sm" stroke>GET</Badge> `/ad_pixels` |
| [Retrieve an ad pixel](/api-reference/beta/ad-pixels/retrieve-an-ad-pixel) | <Badge color="blue" size="sm" stroke>GET</Badge> `/ad_pixels/{id}` |
| [Create an ad pixel](/api-reference/beta/ad-pixels/create-an-ad-pixel) | <Badge color="green" size="sm" stroke>POST</Badge> `/ad_pixels` |
| [Update an ad pixel](/api-reference/beta/ad-pixels/update-an-ad-pixel) | <Badge color="orange" size="sm" stroke>PATCH</Badge> `/ad_pixels/{id}` |
| [Delete an ad pixel](/api-reference/beta/ad-pixels/delete-an-ad-pixel) | <Badge color="red" size="sm" stroke>DELETE</Badge> `/ad_pixels/{id}` |

## Attributes

<Columns cols={2}>
  <Column>
    <ResponseField name="id" type="string" required>
      Ad pixel ID, prefixed `adpx_`.
    </ResponseField>

    <ResponseField name="account_id" type="string" required>
      The business whose claimed campaigns send conversions to this pixel, prefixed
      `biz_`.
    </ResponseField>

    <ResponseField name="created_at" type="string" required>
      When the pixel was added, as an ISO 8601 timestamp.
    </ResponseField>

    <ResponseField name="error_message" type="string | null" required>
      Why the ad platform rejected the last delivery. Null unless `status` is
      `errored`.
    </ResponseField>

    <ResponseField name="external_id" type="string" required>
      The pixel's ID on the ad platform.
    </ResponseField>

    <ResponseField name="name" type="string | null" required>
      The pixel's name on the ad platform. Null when the ad platform returned none.
    </ResponseField>

    <ResponseField name="platform" type="string" required>
      The ad platform the pixel belongs to.

      Available options: `meta`
    </ResponseField>

    <ResponseField name="status" type="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`
    </ResponseField>

    <ResponseField name="updated_at" type="string" required>
      When the pixel was last changed, as an ISO 8601 timestamp.
    </ResponseField>
  </Column>

  <Column>
    <div className="api-resource-sticky-example">
      ```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"
      }
      ```
    </div>
  </Column>
</Columns>


## Related topics

- [Update an Ad Pixel](/api-reference/beta/ad-pixels/update-an-ad-pixel.md)
- [Retrieve an Ad Pixel](/api-reference/beta/ad-pixels/retrieve-an-ad-pixel.md)
- [Create an Ad Pixel](/api-reference/beta/ad-pixels/create-an-ad-pixel.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.