Skip to main content
PATCH
TypeScript

Autorisations

Authorization
string
header
requis

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

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

The ad campaign ID.

Corps

application/json
budget_amount
number

The campaign budget in USD, which is what it is stored and billed in. Interpreted as daily or lifetime per the campaign's budget type, including a budget_type sent in the same request.

Exemple:

40

budget_amount_local
number

The campaign budget stated in the account's ads reporting currency (budget_currency on the response) instead of USD. Converted to USD at the current exchange rate and stored as budget_amount; an amount equal to the current budget_amount_local keeps the stored USD budget as is. Provide this or budget_amount, not both.

budget_optimization
enum<string>

Which level owns the budget: the whole campaign (ad_campaign) or each ad group individually (ad_group). Only changeable before the campaign launches; switching to ad_campaign requires budget_amount in the same request, and switching to ad_group clears the campaign budget.

Options disponibles:
ad_campaign,
ad_group
Exemple:

"ad_campaign"

budget_type
enum<string>

Whether budget_amount is spent per day (daily) or over the campaign's full run (lifetime). Only changeable while the campaign is a draft; send budget_amount in the same request so the amount lands on the new type.

Options disponibles:
daily,
lifetime
Exemple:

"daily"

campaign_type
enum<string>

Accepted only when it matches the campaign's current type, so a read can be sent back unchanged. The type is fixed at creation.

Options disponibles:
standard,
search
Exemple:

"standard"

desired_cost_per_result
number | null

The cost per result, in USD, you want this campaign to achieve. A target only: it is not a bid, cost cap, or bid cap, and doesn't change how the campaign's ads bid. Ad groups set cost and bid caps with their own desired_cost_per_result. null clears it.

ends_at
string

When the campaign stops delivering, as an ISO 8601 timestamp. Only for campaigns that own the budget.

Exemple:

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

special_ad_categories
enum<string>[]

Regulated categories the campaign falls under. Editable on any campaign, draft or launched; pass an empty array to clear.

Options disponibles:
housing,
employment,
financial_products,
politics
starts_at
string

When the campaign starts delivering, as an ISO 8601 timestamp. Only for campaigns that own the budget.

Exemple:

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

status
enum<string>

Set to active to launch a draft campaign (moderates and pushes it live). Live-campaign pause and resume use the pause and unpause actions.

Options disponibles:
active
Exemple:

"active"

title
string

The name of the campaign.

Exemple:

"Now hiring mobile detailers — Austin & Round Rock"

Réponse

200 - application/json

ad campaign updated

account
object | null
requis

The business running this campaign, with the name and logo its ads show.

added_to_cart_value
number
requis

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

Exemple:

12650

added_to_carts
number
requis

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

Exemple:

165

budget_amount
number | null
requis

The campaign's budget in USD, which is what it is stored and billed in. null when each ad group sets its own budget instead.

Exemple:

50

budget_amount_local
number | null
requis

The same budget stated in budget_currency at today's exchange rate, for display in the account's ads reporting currency. null when budget_amount is.

Exemple:

50

budget_currency
string
requis

The ISO 4217 code budget_amount_local is in: the account's ads_reporting_currency preference. usd unless the account changed it.

Exemple:

"usd"

budget_optimization
enum<string> | null
requis

Which level owns the budget: the whole campaign (ad_campaign) or each ad group individually (ad_group).

Options disponibles:
ad_campaign,
ad_group,
null
Exemple:

"ad_group"

budget_type
enum<string> | null
requis

Whether budget_amount is spent per day (daily) or over the campaign's full run (lifetime).

Options disponibles:
daily,
lifetime,
null
Exemple:

"daily"

campaign_type
enum<string>
requis

The kind of campaign, fixed at creation. standard runs image and video ads; search shows text ads on search results for the ad groups' keywords.

Options disponibles:
standard,
search
Exemple:

"standard"

click_through_rate
number
requis

Clicks divided by impressions, between 0 and 1.

Exemple:

0.025

clicks
number
requis

The number of clicks.

Exemple:

5500

completed_registration_value
number
requis

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

Exemple:

1650

completed_registrations
number
requis

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

Exemple:

55

contact_value
number
requis

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

Exemple:

2640

contacts
number
requis

Whop pixel-attributed contact events, last-click.

Exemple:

88

cost_per_added_to_cart
number | null
requis

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

Exemple:

8

cost_per_click
number
requis

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

Exemple:

0.24

cost_per_completed_registration
number | null
requis

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

Exemple:

24

cost_per_contact
number | null
requis

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

Exemple:

15

cost_per_lead
number | null
requis

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

Exemple:

10

cost_per_mille
number
requis

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

Exemple:

6

cost_per_purchase
number | null
requis

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

Exemple:

30

cost_per_result
number | null
requis

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

Exemple:

40

cost_per_schedule
number | null
requis

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

Exemple:

22

cost_per_submitted_application
number | null
requis

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

Exemple:

120

cost_per_unique_click
number | null
requis

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

Exemple:

0.4

cost_per_viewed_content
number | null
requis

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

Exemple:

1.1

created_at
string
requis

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

Exemple:

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

custom_conversions
number
requis

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

Exemple:

41

custom_event_counts
object
requis

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.

Exemple:
custom_event_values
object
requis

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.

Exemple:
delivery_status
enum<string>
requis

Whether the campaign's ads are delivering right now, and if not, why. Content review is in_review; a campaign waiting to start is processing. Account billing failures set payment_failed without changing the configured status. Successful payment retry clears that block and recalculates delivery. When several states apply at once, the highest-precedence one is returned.

Options disponibles:
payment_failed,
all_ads_rejected,
draft,
paused,
in_review,
learning,
processing,
revise_content,
issues,
scheduled,
completed,
active
Exemple:

"issues"

ends_at
string | null
requis

When the campaign stops delivering, as an ISO 8601 timestamp. null when it runs until paused, or when its ad groups set their own schedule.

Exemple:

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

frequency
number | null
requis

Impressions divided by reach.

Exemple:

null

id
string
requis

Unique identifier for the ad campaign, prefixed adcamp_.

Exemple:

"adcamp_xxxxxxxxxxxxxx"

impressions
number
requis

The number of impressions.

Exemple:

220000

issues
object[]
requis
lead_value
number
requis

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

Exemple:

3960

leads
number
requis

Whop pixel-attributed leads, last-click.

Exemple:

132

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

Exemple:

4400

objective
enum<string> | null
requis

The goal the campaign optimizes toward. awareness appears only on campaigns created before it was retired; those campaigns can't launch.

Options disponibles:
awareness,
traffic,
engagement,
leads,
sales,
null
Exemple:

"leads"

purchase_value
number
requis

USD value of pixel-attributed purchases.

Exemple:

7920

purchases
number
requis

Whop pixel-attributed purchases, last-click.

Exemple:

44

reach
number
requis

The number of unique people who saw this.

Exemple:

0

result_event
enum<string> | null
requis

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.

Options disponibles:
purchase,
lead,
schedule,
submit_application,
contact,
complete_registration,
view_content,
add_to_cart,
custom,
messaging_conversation,
null
Exemple:

"custom"

result_event_name
string | null
requis

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

Exemple:

"quote_requested"

results
number | null
requis

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.

Exemple:

33

return_on_ad_spend
number
requis

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

Exemple:

6

schedule_value
number
requis

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

Exemple:

5400

schedules
number
requis

Whop pixel-attributed schedule events, last-click.

Exemple:

60

special_ad_categories
enum<string>[]
requis

Regulated categories the campaign is declared under. Ads in these categories are subject to extra targeting restrictions. Empty when none apply.

Options disponibles:
housing,
employment,
financial_products,
politics
spend
number
requis

The amount charged, in spend_currency.

Exemple:

1320

spend_currency
string | null
requis

The ISO 4217 currency code of all monetary metrics.

Exemple:

"usd"

starts_at
string | null
requis

When the campaign starts delivering, as an ISO 8601 timestamp. null when it starts as soon as it launches, or when its ad groups set their own schedule.

Exemple:

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

status
enum<string>
requis

The configured lifecycle status of the ad campaign. Billing failures preserve active or paused here and set delivery_status to payment_failed.

Options disponibles:
active,
paused,
inactive,
payment_failed,
draft,
duplicating
Exemple:

"active"

submitted_application_value
number
requis

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

Exemple:

1320

submitted_applications
number
requis

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

Exemple:

11

target_cost_per_result
number | null
requis

The desired cost per result for target_result_event, in USD. null when none is set.

Exemple:

null

target_result_event
string | null
requis

The event target_cost_per_result is priced per, such as purchase or lead. null when the campaign has no single goal.

Exemple:

null

title
string
requis

Display name of the ad campaign.

Exemple:

"Ceramic coating — Austin leads"

unique_click_through_rate
number | null
requis

Unique clicks divided by impressions, between 0 and 1.

Exemple:

null

unique_clicks
number
requis

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

Exemple:

3300

updated_at
string
requis

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

Exemple:

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

viewed_content_value
number
requis

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

Exemple:

8400

viewed_contents
number
requis

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

Exemple:

1200

desired_cost_per_result
number | null

The cost per result, in USD, the advertiser wants this campaign to achieve. A target only: it is not a bid, cost cap, or bid cap, and doesn't change how the campaign's ads bid. null when no target is set.

Exemple:

4.5