Sign in
latestOpenAPI 3.1.02026-08-143874115.7 MB

a84d4905fdbb

Ad Campaigns

Update an Ad Campaign

Updates an ad campaign's editable fields (title, budget, schedule, bid strategy, special ad categories, and, before launch, budget optimization), and launches a draft campaign by setting status to active. Objective, budget type and desired cost per result are fixed at creation and cannot be changed.

patch/ad_campaigns/{id}

Request body

bid_type'minimum_cost' | 'average_target' | 'maximum_target'

How delivery bids in the ad auction: minimum_cost gets the most results for the budget, average_target holds an average cost per result, maximum_target never bids above a cap. Switching to minimum_cost clears the cap amounts stored on the campaign's ad groups. Only for campaigns that own the budget.

budget_amountnumber

The campaign budget, in the account's currency. Interpreted as daily or lifetime per the campaign's existing budget type.

budget_optimization'ad_campaign' | 'ad_group'

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

ends_atstring

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

special_ad_categoriesstring[]

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

starts_atstring

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

status'active'

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

titlestring

The name of the campaign.

Example request

{
  "bid_type": "average_target",
  "budget_amount": 40,
  "budget_optimization": "ad_campaign",
  "ends_at": "2026-01-01T12:00:00.000Z",
  "special_ad_categories": [
    "employment"
  ],
  "starts_at": "2026-01-01T12:00:00.000Z",
  "status": "active",
  "title": "Now hiring mobile detailers — Austin & Round Rock"
}

Response

ad campaign updated

added_to_cart_valuenumber required

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

added_to_cartsnumber required

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

bid_type'minimum_cost' | 'average_target' | 'maximum_target' | 'null' nullable

How delivery bids in the ad auction: minimum_cost gets the most results for the budget, average_target holds an average cost per result, and maximum_target never bids above a cap.

budget_amountnumber nullable required

The campaign's budget, in the ad account's currency. null when each ad group sets its own budget instead.

budget_optimization'ad_campaign' | 'ad_group' | 'null' nullable required

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

budget_type'daily' | 'lifetime' | 'null' nullable required

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

click_through_ratenumber required

Clicks divided by impressions, between 0 and 1.

clicksnumber required

The number of clicks.

completed_registration_valuenumber required

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

completed_registrationsnumber required

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

contact_valuenumber required

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

contactsnumber required

Whop pixel-attributed contact events, last-click.

cost_per_added_to_cartnumber nullable required

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

cost_per_clicknumber required

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

cost_per_completed_registrationnumber nullable required

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

cost_per_contactnumber nullable required

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

cost_per_leadnumber nullable required

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

cost_per_millenumber required

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

cost_per_purchasenumber nullable required

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

cost_per_resultnumber nullable required

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

cost_per_schedulenumber nullable required

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

cost_per_submitted_applicationnumber nullable required

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

cost_per_unique_clicknumber nullable required

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

cost_per_viewed_contentnumber nullable required

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

created_atstring required

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

custom_conversionsnumber required

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

custom_event_countsobject required

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.

custom_event_valuesobject required

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.

delivery_status'payment_failed' | 'all_ads_rejected' | 'draft' | 'no_ad_groups' | 'no_ads' | 'paused' | 'processing' | 'issues' | 'scheduled' | 'completed' | 'ad_groups_off' | 'active' required

Whether the campaign's ads are delivering right now, and if not, why. When several states apply at once, the highest-precedence one is returned.

frequencynumber nullable required

Platform-reported impressions divided by reach.

idstring required

Unique identifier for the ad campaign, prefixed adcamp_.

impressionsnumber required

The number of impressions.

lead_valuenumber required

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

leadsnumber required

Whop pixel-attributed leads, last-click.

objective'awareness' | 'traffic' | 'engagement' | 'leads' | 'sales' | 'null' nullable required

The goal the campaign optimizes toward.

optimization_goalstring nullable required

The event the campaign optimizes for when a single goal is set campaign-wide. null when each ad group sets its own optimization_goal.

platform'meta' | 'tiktok' required

The ad network the campaign runs on.

purchase_valuenumber required

USD value of pixel-attributed purchases.

purchasesnumber required

Whop pixel-attributed purchases, last-click.

reachnumber required

The number of unique people who saw this.

result_event'purchase' | 'lead' | 'schedule' | 'submit_application' | 'contact' | 'complete_registration' | 'view_content' | 'add_to_cart' | 'custom' | 'null' nullable required

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.

result_event_namestring nullable required

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

resultsnumber nullable required

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.

return_on_ad_spendnumber required

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

schedule_valuenumber required

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

schedulesnumber required

Whop pixel-attributed schedule events, last-click.

special_ad_categoriesstring[] required
spendnumber required

The amount charged, in spend_currency.

spend_currencystring nullable required

The ISO 4217 currency code of all monetary metrics.

status'active' | 'paused' | 'inactive' | 'stale' | 'pending_refund' | 'payment_failed' | 'draft' | 'in_review' | 'flagged' | 'importing' | 'imported' | 'duplicating' required

The lifecycle status of the ad campaign.

submitted_application_valuenumber required

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

submitted_applicationsnumber required

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

titlestring required

Display name of the ad campaign.

unique_click_through_ratenumber nullable required

Unique clicks divided by impressions, between 0 and 1.

unique_clicksnumber required

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

updated_atstring required

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

viewed_content_valuenumber required

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

viewed_contentsnumber required

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

Example response

{
  "added_to_cart_value": 12650,
  "added_to_carts": 165,
  "bid_type": "average_target",
  "budget_amount": 50,
  "budget_optimization": "ad_group",
  "budget_type": "daily",
  "click_through_rate": 0.025,
  "clicks": 5500,
  "completed_registration_value": 1650,
  "completed_registrations": 55,
  "contact_value": 2640,
  "contacts": 88,
  "cost_per_added_to_cart": 8,
  "cost_per_click": 0.24,
  "cost_per_completed_registration": 24,
  "cost_per_contact": 15,
  "cost_per_lead": 10,
  "cost_per_mille": 6,
  "cost_per_purchase": 30,
  "cost_per_result": 40,
  "cost_per_schedule": 22,
  "cost_per_submitted_application": 120,
  "cost_per_unique_click": 0.4,
  "cost_per_viewed_content": 1.1,
  "created_at": "2026-01-01T12:00:00.000Z",
  "custom_conversions": 41,
  "custom_event_counts": {
    "gift_card_purchased": 5,
    "quote_requested": 33
  },
  "custom_event_values": {
    "gift_card_purchased": 750,
    "quote_requested": 0
  },
  "delivery_status": "issues",
  "id": "adcamp_xxxxxxxxxxxxxx",
  "impressions": 220000,
  "issues": [
    {
      "id": "adiss_xxxxxxxxxxxxxx",
      "message": "Your ad was rejected for unacceptable business practices. Edit the ad's content and resubmit.",
      "resource_id": "ad_xxxxxxxxxxxxxx",
      "resource_type": "ad"
    }
  ],
  "lead_value": 3960,
  "leads": 132,
  "objective": "leads",
  "platform": "meta",
  "purchase_value": 7920,
  "purchases": 44,
  "result_event": "custom",
  "result_event_name": "quote_requested",
  "results": 33,
  "return_on_ad_spend": 6,
  "schedule_value": 5400,
  "schedules": 60,
  "special_ad_categories": [
    "employment"
  ],
  "spend": 1320,
  "spend_currency": "usd",
  "status": "active",
  "submitted_application_value": 1320,
  "submitted_applications": 11,
  "title": "Ceramic coating — Austin leads",
  "unique_clicks": 3300,
  "updated_at": "2026-01-01T12:00:00.000Z",
  "viewed_content_value": 8400,
  "viewed_contents": 1200
}