Skip to main content
POST
Create an ad pixel

Authorizations

Authorization
string
header
required

A user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Headers

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-10-09-1"

Body

application/json
access_token
string
required
write-only

An access token that can send events to the pixel on the ad platform. Whop never returns it.

Example:

"new-token"

account_id
string
required

The business whose claimed campaigns send conversions to this pixel, prefixed biz_. You must have claimed at least one of its campaigns.

Example:

"biz_xxxxxxxxxxxxxx"

external_id
string
required

The pixel's ID on the ad platform.

Example:

"998877665544"

platform
enum<string>
required

The ad platform the pixel belongs to.

Available options:
meta
Example:

"meta"

Response

Created

account_id
string
required

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

Example:

"biz_xxxxxxxxxxxxxx"

created_at
string
required

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

Example:

"2026-01-01T12:00:00.000Z"

error_message
string | null
required

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

Example:

null

external_id
string
required

The pixel's ID on the ad platform.

Example:

"111222001"

id
string
required

Ad pixel ID, prefixed adpx_.

Example:

"adpx_xxxxxxxxxxxxxx"

name
string | null
required

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

Example:

"Supplier pixel"

platform
enum<string>
required

The ad platform the pixel belongs to.

Available options:
meta
Example:

"meta"

status
enum<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
Example:

"active"

updated_at
string
required

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

Example:

"2026-01-01T12:00:00.000Z"