Skip to main content
POST
Create an ad pixel

Autorizaciones

Authorization
string
header
requerido

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

Scopes

ad_pixel:manage

Encabezados

Idempotency-Key
string

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

Maximum string length: 255
Ejemplo:

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

Api-Version-Date
string

Pins the request to a dated API version.

Ejemplo:

"2026-11-17"

Cuerpo

application/json
access_token
string
requerido
write-only

A credential that can send events to the pixel on the ad platform. For meta, a Conversions API access token. For tiktok, an Events API access token. For thrad, an API key with events:write for the tag. For google, the JSON key of a Google Cloud service account. Give the service account Standard access to the Google Ads account. In its project, turn on the Google Ads API and the Data Manager API. The project also needs Explorer access or higher to the Google Ads API. Use a service account made only for Whop, with no roles in its project. Whop never returns it.

Ejemplo:

"new-token"

account_id
string
requerido

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

Ejemplo:

"biz_xxxxxxxxxxxxxx"

external_id
string
requerido

The pixel's ID on the ad platform: a Meta pixel or dataset ID, TikTok pixel code, Google Ads customer ID, or Thrad tag ID.

Ejemplo:

"998877665544"

platform
enum<string>
requerido

The ad platform the pixel belongs to.

Opciones disponibles:
meta,
tiktok,
google,
thrad
Ejemplo:

"meta"

Respuesta

Created

account
object
requerido

The business whose claimed campaigns send conversions to this pixel, with its name and logo.

account_id
string
requerido

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

Ejemplo:

"biz_xxxxxxxxxxxxxx"

created_at
string
requerido

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

Ejemplo:

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

error_message
string | null
requerido

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

Ejemplo:

null

external_id
string
requerido

The pixel's ID on the ad platform: a Meta pixel or dataset ID, TikTok pixel code, Google Ads customer ID, or Thrad tag ID.

Ejemplo:

"111222001"

id
string
requerido

Ad pixel ID, prefixed adpx_.

Ejemplo:

"adpx_xxxxxxxxxxxxxx"

name
string | null
requerido

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

Ejemplo:

"Supplier pixel"

platform
enum<string>
requerido

The ad platform the pixel belongs to.

Opciones disponibles:
meta,
tiktok,
google,
thrad
Ejemplo:

"meta"

status
enum<string>
requerido

active receives conversions. errored stopped because the ad platform rejected the access token; update the token to resume. disabled was turned off by Whop.

Opciones disponibles:
active,
errored,
disabled
Ejemplo:

"active"

updated_at
string
requerido

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

Ejemplo:

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