Skip to main content
PATCH
Update an ad pixel

Autorisations

Authorization
string
header
requis

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

En-têtes

Api-Version-Date
string

Pins the request to a dated API version.

Exemple:

"2026-11-17"

Paramètres de chemin

id
string
requis

Ad pixel ID, prefixed adpx_.

Corps

application/json
access_token
string
requis
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.

Exemple:

"new-token"

Réponse

Updated

account
object
requis

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

account_id
string
requis

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

Exemple:

"biz_xxxxxxxxxxxxxx"

created_at
string
requis

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

Exemple:

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

error_message
string | null
requis

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

Exemple:

null

external_id
string
requis

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.

Exemple:

"111222001"

id
string
requis

Ad pixel ID, prefixed adpx_.

Exemple:

"adpx_xxxxxxxxxxxxxx"

name
string | null
requis

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

Exemple:

"Supplier pixel"

platform
enum<string>
requis

The ad platform the pixel belongs to.

Options disponibles:
meta,
tiktok,
google,
thrad
Exemple:

"meta"

status
enum<string>
requis

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

Options disponibles:
active,
errored,
disabled
Exemple:

"active"

updated_at
string
requis

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

Exemple:

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