Skip to main content
POST
TypeScript

Autorisaties

Authorization
string
header
vereist

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

ad_campaign:update

Headers

Idempotency-Key
string

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

Maximum string length: 255
Voorbeeld:

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

Api-Version-Date
string

Pins the request to a dated API version.

Voorbeeld:

"2026-11-17"

Padparameters

id
string
vereist

The ad ID.

Respons

ad unpaused

ad_campaign
object
vereist

The ad campaign this ad belongs to.

ad_group
object
vereist

The ad group this ad belongs to.

added_to_cart_value
number
vereist

USD value attributed to add-to-cart events. Sums the value sent with each event, normalized to USD; events without a value contribute 0.

Voorbeeld:

1850

added_to_carts
number
vereist

Whop pixel-attributed add-to-cart events, last-click.

Voorbeeld:

74

call_to_action
enum<string> | null
vereist

The call-to-action button shown on the ad.

Beschikbare opties:
learn_more,
shop_now,
sign_up,
subscribe,
get_started,
book_now,
apply_now,
contact_us,
download,
order_now,
buy_now,
get_quote,
message_page,
whatsapp_message,
instagram_message,
call_now,
get_directions,
send_updates,
get_offer,
watch_more,
listen_now,
play_game,
open_link,
no_button,
get_offer_view,
get_event_tickets,
see_menu,
request_time,
event_rsvp,
see_details,
view_instagram_profile,
donate_now,
see_more,
visit_site,
null
Voorbeeld:

"learn_more"

click_through_rate
number
vereist

Clicks divided by impressions, between 0 and 1.

Voorbeeld:

0.0261

clicks
number
vereist

The number of clicks.

Voorbeeld:

1337

completed_registration_value
number
vereist

USD value attributed to complete-registration events. Sums the value sent with each event, normalized to USD; events without a value contribute 0.

Voorbeeld:

95

completed_registrations
number
vereist

Whop pixel-attributed complete-registration events, last-click.

Voorbeeld:

19

contact_value
number
vereist

USD value attributed to contact events. Sums the value sent with each event, normalized to USD; events without a value contribute 0.

Voorbeeld:

175

contacts
number
vereist

Whop pixel-attributed contact events, last-click.

Voorbeeld:

27

content_review
object
vereist

Whop's content review of this ad: whether it has finished, which ad networks it is recommended for, and the content rules it breaks.

cost_per_added_to_cart
number | null
vereist

Spend divided by attributed add-to-cart events; null when they are not the goal and none are attributed.

Voorbeeld:

6.515675675675676

cost_per_click
number
vereist

Spend divided by clicks; 0 when there are no clicks.

Voorbeeld:

0.36

cost_per_completed_registration
number | null
vereist

Spend divided by attributed complete-registration events; null when they are not the goal and none are attributed.

Voorbeeld:

25.37684210526316

cost_per_contact
number | null
vereist

Spend divided by attributed contact events; null when contacts are not the goal and none are attributed.

Voorbeeld:

17.85777777777778

cost_per_lead
number | null
vereist

Spend divided by attributed leads; null when leads are not a goal and none are attributed.

Voorbeeld:

3.984793388429752

cost_per_mille
number
vereist

Spend per 1,000 impressions; 0 when there are no impressions.

Voorbeeld:

9.42

cost_per_purchase
number | null
vereist

Spend divided by attributed purchases; null when purchases are not a goal and none are attributed.

Voorbeeld:

12.68842105263158

cost_per_result
number | null
vereist

Spend divided by Whop pixel-attributed results; null when nothing Whop-attributable is being optimized for.

Voorbeeld:

12.68842105263158

cost_per_schedule
number | null
vereist

Spend divided by attributed schedule events; null when schedules are not the goal and none are attributed.

Voorbeeld:

10.48173913043478

cost_per_submitted_application
number | null
vereist

Spend divided by attributed submit-application events; null when they are not the goal and none are attributed.

Voorbeeld:

40.18

cost_per_unique_click
number | null
vereist

Spend divided by unique clicks; null when there are no unique clicks.

Voorbeeld:

0.48

cost_per_viewed_content
number | null
vereist

Spend divided by attributed view-content events; null when they are not the goal and none are attributed.

Voorbeeld:

0.2253084112149533

created_at
string
vereist

When the ad was created, as an ISO 8601 timestamp.

Voorbeeld:

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

creatives
object[]
vereist
custom_conversions
number
vereist

Whop pixel-attributed custom (merchant-defined) conversion events, last-click, across all custom event names.

Voorbeeld:

63

custom_event_counts
object
vereist

Whop pixel-attributed custom conversions, keyed by your event name with its last-click count as the value. Empty when no named custom events are attributed. Custom events fired without a name are counted in custom_conversions but omitted here, so these values sum to at most custom_conversions.

Voorbeeld:
custom_event_values
object
vereist

Conversion value attributed to each custom event, keyed by event name like custom_event_counts. Sums the value passed to whop.track, normalized to USD; events fired without a value contribute 0.

Voorbeeld:
delivery_status
enum<string>
vereist

Whether the ad is delivering right now, and if not, why. When several states apply at once, the highest-precedence one is returned.

Beschikbare opties:
rejected,
in_review,
draft,
campaign_paused,
paused,
processing,
revise_content,
issues,
scheduled,
learning,
active
Voorbeeld:

"processing"

descriptions
object[]
vereist
frequency
number | null
vereist

Impressions divided by reach.

Voorbeeld:

null

headlines
object[]
vereist
id
string
vereist

Unique identifier for the ad, prefixed ad_.

Voorbeeld:

"ad_xxxxxxxxxxxxxx"

impressions
number
vereist

The number of impressions.

Voorbeeld:

51204

issues
object[]
vereist
lead_value
number
vereist

USD value attributed to lead events. Sums the value sent with each event, normalized to USD; events without a value contribute 0.

Voorbeeld:

1180

leads
number
vereist

Whop pixel-attributed leads, last-click.

Voorbeeld:

121

Page views on your destination from people who clicked the ad, recorded by the Whop pixel. Counted the same way on every ad platform.

Voorbeeld:

1071

primary_texts
object[]
vereist
purchase_value
number
vereist

USD value of pixel-attributed purchases.

Voorbeeld:

9462

purchases
number
vereist

Whop pixel-attributed purchases, last-click.

Voorbeeld:

38

reach
number
vereist

The number of unique people who saw this.

Voorbeeld:

0

result_event
enum<string> | null
vereist

The Whop pixel conversion event whose attributed count represents results — the optimization goal, or the highest-volume attributed event for campaigns that budget per ad group. Null when the goal isn't a Whop-attributed event.

Beschikbare opties:
purchase,
lead,
schedule,
submit_application,
contact,
complete_registration,
view_content,
add_to_cart,
custom,
messaging_conversation,
null
Voorbeeld:

"purchase"

result_event_name
string | null
vereist

The merchant-defined event name when result_event is custom; null for the standard events.

Voorbeeld:

"booked_detail"

results
number | null
vereist

The Whop pixel-attributed count behind result_event. When a campaign's ad groups optimize different goals there is no single result_event (it is null), and this is instead the sum of each ad group's own attributed results. Null when nothing Whop-attributable is being optimized for.

Voorbeeld:

38

return_on_ad_spend
number
vereist

Purchase value divided by spend, both in USD (a currency-neutral ratio); 0 when there is no spend.

Voorbeeld:

19.62419113987058

schedule_value
number
vereist

USD value attributed to schedule events. Sums the value sent with each event, normalized to USD; events without a value contribute 0.

Voorbeeld:

640

schedules
number
vereist

Whop pixel-attributed schedule events, last-click.

Voorbeeld:

46

spend
number
vereist

The amount charged, in spend_currency.

Voorbeeld:

482.16

spend_currency
string | null
vereist

The ISO 4217 currency code of all monetary metrics.

Voorbeeld:

"usd"

status
enum<string>
vereist

Whether the ad is enabled. active and paused are set by you; in_review and rejected come from ad review.

Beschikbare opties:
active,
paused,
in_review,
rejected
Voorbeeld:

"active"

submitted_application_value
number
vereist

USD value attributed to submit-application events. Sums the value sent with each event, normalized to USD; events without a value contribute 0.

Voorbeeld:

300

submitted_applications
number
vereist

Whop pixel-attributed submit-application events, last-click.

Voorbeeld:

12

title
string | null
vereist

Display title of the ad.

Voorbeeld:

"Hero video (Copy 1)"

unique_click_through_rate
number | null
vereist

Unique clicks divided by impressions, between 0 and 1.

Voorbeeld:

null

unique_clicks
number
vereist

People who clicked, reported by the Whop pixel, counted once per person.

Voorbeeld:

1012

updated_at
string
vereist

When the ad was last updated, as an ISO 8601 timestamp.

Voorbeeld:

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

url
string | null
vereist

The URL the ad links to, without its query string. Parameters belong in url_parameters; any you send on url are moved there.

Voorbeeld:

"https://shinetime.example/ceramic-coating"

url_parameters
object
vereist

Query parameters appended to url, keyed by name. Whop's click-attribution parameters are reserved.

Voorbeeld:
viewed_content_value
number
vereist

USD value attributed to view-content events. Sums the value sent with each event, normalized to USD; events without a value contribute 0.

Voorbeeld:

0

viewed_contents
number
vereist

Whop pixel-attributed view-content events, last-click.

Voorbeeld:

2140