--- title: "Unpause an Ad" method: POST path: "/ads/{id}/unpause" tags: ["Ads"] --- # Unpause an Ad `POST /ads/{id}/unpause` Resumes a paused ad. ## Headers - `Idempotency-Key` string ## Response `200` ad unpaused - Ad - `ad_campaign` AdEntityReference, required - `id` string, required — The referenced entity's id. - `ad_group` AdEntityReference, required - `id` string, required — The referenced entity's id. - `added_to_cart_value` number, 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_carts` number, required — Whop pixel-attributed add-to-cart events, last-click. - `call_to_action` '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' | 'null', nullable, required — The call-to-action button shown on the ad. - `click_through_rate` number, required — Clicks divided by impressions, between 0 and 1. - `clicks` number, required — The number of clicks. - `completed_registration_value` number, 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_registrations` number, required — Whop pixel-attributed complete-registration events, last-click. - `contact_value` number, required — USD value attributed to contact events. Sums the value sent with each event, normalized to USD; events without a value contribute 0. - `contacts` number, required — Whop pixel-attributed contact events, last-click. - `cost_per_added_to_cart` number, nullable, required — Spend divided by attributed add-to-cart events; null when they are not the goal and none are attributed. - `cost_per_click` number, required — Spend divided by clicks; 0 when there are no clicks. - `cost_per_completed_registration` number, nullable, required — Spend divided by attributed complete-registration events; null when they are not the goal and none are attributed. - `cost_per_contact` number, nullable, required — Spend divided by attributed contact events; null when contacts are not the goal and none are attributed. - `cost_per_lead` number, nullable, required — Spend divided by attributed leads; null when leads are not a goal and none are attributed. - `cost_per_mille` number, required — Spend per 1,000 impressions; 0 when there are no impressions. - `cost_per_purchase` number, nullable, required — Spend divided by attributed purchases; null when purchases are not a goal and none are attributed. - `cost_per_result` number, nullable, required — Spend divided by Whop pixel-attributed results; null when nothing Whop-attributable is being optimized for. - `cost_per_schedule` number, nullable, required — Spend divided by attributed schedule events; null when schedules are not the goal and none are attributed. - `cost_per_submitted_application` number, nullable, required — Spend divided by attributed submit-application events; null when they are not the goal and none are attributed. - `cost_per_unique_click` number, nullable, required — Spend divided by unique clicks; null when there are no unique clicks. - `cost_per_viewed_content` number, nullable, required — Spend divided by attributed view-content events; null when they are not the goal and none are attributed. - `created_at` string, required — When the ad was created, as an ISO 8601 timestamp. - `creatives` AdCreative[], required - `crop` AdCreativeCrop, required - `height` number, required — Height of the crop window in source pixels. - `width` number, required — Width of the crop window in source pixels. - `x` number, required — Left edge of the crop window in source pixels. - `y` number, required — Top edge of the crop window in source pixels. - `format` 'square' | 'vertical' | 'horizontal' | 'null', nullable, required — The placement variant this asset covers, or null for the original asset. - `id` string, required — The creative attachment's file id. - `media_type` string, nullable, required — The kind of asset, image or video. - `url` string, nullable, required — CDN url of the asset. - `custom_conversions` number, required — Whop pixel-attributed custom (merchant-defined) conversion events, last-click, across all custom event names. - `custom_event_counts` object, 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_values` object, 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` 'rejected' | 'in_review' | 'draft' | 'campaign_paused' | 'ad_group_paused' | 'paused' | 'processing' | 'issues' | 'learning_limited' | 'learning' | 'active', required — Whether the ad is delivering right now, and if not, why. When several states apply at once, the highest-precedence one is returned. - `descriptions` string[], required - `frequency` number, nullable, required — Platform-reported impressions divided by reach. - `headlines` string[], required - `id` string, required — Unique identifier for the ad, prefixed `ad_`. - `impressions` number, required — The number of impressions. - `issues` AdPlatformIssue[], required - `id` string, required — Unique identifier for the issue. - `message` string, required — A description of what the issue is and how it can be resolved. - `resource_id` string, nullable, required — The ID of the campaign, ad group, or ad the issue is attached to. - `resource_type` 'ad_campaign' | 'ad_group' | 'ad', required — The type of resource the issue is attached to. - `lead_form` AdLeadForm - `completion` AdLeadFormCompletion, required - `button_text` string, nullable, required — Text of the follow-up button. - `description` string, nullable, required — Body text under the headline. - `headline` string, nullable, required — Headline of the completion screen. - `url` string, nullable, required — Website the follow-up button opens. `null` when the screen has no button. - `disclaimer` AdLeadFormDisclaimer, required - `body` string, nullable, required — Disclaimer text. - `checkboxes` AdLeadFormDisclaimerCheckbox[], required - `checked_by_default` boolean, nullable, required — Whether the checkbox starts ticked. - `key` string, nullable, required — Stable identifier consent responses are stored under. - `required` boolean, nullable, required — Whether the checkbox must be ticked to submit the form. - `text` string, required — Consent text next to the checkbox. - `title` string, nullable, required — Disclaimer title. - `form_type` 'more_volume' | 'higher_intent', required — `more_volume` is quickest to submit; `higher_intent` adds a confirmation step before submission. - `intro` AdLeadFormIntro, required - `description` string, nullable, required — Body text under the headline. - `headline` string, nullable, required — Headline of the intro screen. - `name` string, nullable, required — Internal name of the form. - `phone_verification` boolean, required — Whether the phone number must be verified by SMS before submitting. - `privacy_policy` AdLeadFormPrivacyPolicy, required - `link_text` string, nullable, required — Link text shown for the policy. `null` uses the platform default. - `url` string, required — URL of your privacy policy. - `questions` AdLeadFormQuestion[], required - `format` string — Answer format for `custom` questions: `short_answer`, `multiple_choice`, or `appointment`. Absent otherwise. - `label` string — Question text for `custom` questions. Absent for standard prefill questions. - `options` AdLeadFormQuestionOption[] - `key` string, nullable — Stable identifier the choice's answers are stored under. Absent for simple choices. - `logic` AdLeadFormOptionLogic - `action` 'go_to_question' | 'submit_form' | 'close_form', required — What happens when the choice is selected. - `target_end_page_index` number — Zero-based index of the ending screen to jump to. - `target_question_index` number — Zero-based index of the question to jump to, for `go_to_question`. - `value` string, required — Choice text shown to the person. - `type` string, required — Question type: a standard prefill type such as `email`, `phone`, or `full_name`, or `custom` for your own question. - `lead_form_id` string, nullable — The ad platform's ID for the instant form the ad uses. Set when the ad references an existing form via `lead_form_id`, or once a form built from `lead_form` has been created on the platform. - `lead_value` number, required — USD value attributed to lead events. Sums the value sent with each event, normalized to USD; events without a value contribute 0. - `leads` number, required — Whop pixel-attributed leads, last-click. - `messaging_config` AdMessagingConfig - `keyword` string, nullable, required — Suggested reply the person can tap to start the conversation. - `message` string, nullable, required — Greeting shown when the conversation opens. - `multi_advertiser_ads` boolean — Whether the ad can appear alongside other advertisers' ads in the same unit. Defaults to true. - `post_id` string, nullable, required — The existing post this ad promotes — a Facebook post or Instagram media ID. `null` when the ad uses uploaded creatives. - `post_source` 'facebook' | 'instagram' | 'null', nullable, required — Identifies the network that owns `post_id`; `null` when the ad uses uploaded creatives. - `post_thumbnail_url` string, nullable, required — Preview image of the existing post this ad promotes. `null` for ads that use uploaded creatives, or until the post's media has been fetched from the network. - `primary_texts` string[], required - `purchase_value` number, required — USD value of pixel-attributed purchases. - `purchases` number, required — Whop pixel-attributed purchases, last-click. - `reach` number, 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_name` string, nullable, required — The merchant-defined event name when result_event is custom; null for the standard events. - `results` number, 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_spend` number, required — Purchase value divided by spend, both in USD (a currency-neutral ratio); 0 when there is no spend. - `schedule_value` number, required — USD value attributed to schedule events. Sums the value sent with each event, normalized to USD; events without a value contribute 0. - `schedules` number, required — Whop pixel-attributed schedule events, last-click. - `social_accounts` AdEntityReference[], required - `id` string, required — The referenced entity's id. - `spend` number, required — The amount charged, in spend_currency. - `spend_currency` string, nullable, required — The ISO 4217 currency code of all monetary metrics. - `status` 'active' | 'paused' | 'in_review' | 'rejected', required — Whether the ad is enabled. `active` and `paused` are set by you; `in_review` and `rejected` come from ad review. - `submitted_application_value` number, 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_applications` number, required — Whop pixel-attributed submit-application events, last-click. - `title` string, nullable, required — Display title of the ad. - `unique_click_through_rate` number, nullable, required — Unique clicks divided by impressions, between 0 and 1. - `unique_clicks` number, required — People who clicked, reported by the Whop pixel, counted once per person. - `updated_at` string, required — When the ad was last updated, as an ISO 8601 timestamp. - `url` string, nullable, required — The URL the ad links to. - `url_parameters` object, required — Query parameters appended to the URL, keyed by parameter name. - `viewed_content_value` number, 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_contents` number, required — Whop pixel-attributed view-content events, last-click. --- [API](https://skmtc.net/whop/apis/whop-api.md) · [All operations](https://skmtc.net/whop/apis/whop-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/whop/whop-api/versions/db0883548bc5/schema)