Skip to main content
POST
/
ad_groups
/
{id}
/
unpause
Unpause an Ad Group
curl --request POST \
  --url https://{defaultHost}/ad_groups/{id}/unpause \
  --header 'Authorization: Bearer <token>'
{
  "click_through_rate": 123,
  "clicks": 123,
  "cost_per_click": 123,
  "cost_per_lead": 123,
  "cost_per_mille": 123,
  "cost_per_purchase": 123,
  "frequency": 123,
  "impressions": 123,
  "leads": 123,
  "purchase_value": 123,
  "purchases": 123,
  "reach": 123,
  "return_on_ad_spend": 123,
  "spend": 123,
  "spend_currency": "<string>",
  "unique_click_through_rate": 123,
  "unique_clicks": 123,
  "id": "<string>",
  "title": "<string>",
  "status": "active",
  "optimization_goal": "<string>",
  "conversion_location": "website",
  "budget_amount": 123,
  "budget_type": "daily",
  "minimum_daily_spend": 123,
  "bid_type": "minimum_cost",
  "desired_cost_per_result": 123,
  "starts_at": "<string>",
  "ends_at": "<string>",
  "regions": {},
  "audience": {},
  "devices": {},
  "frequency_cap": {},
  "placements": [
    {}
  ],
  "ad_campaign": {},
  "created_at": "<string>",
  "updated_at": "<string>",
  "issues": [
    {
      "id": "<string>",
      "category": "policy_rejection",
      "resource_id": "<string>",
      "resource_type": "ad_campaign"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

An account API key, account scoped JWT, app API key, or user OAuth token.

Headers

​
Api-Version-Date
string<date>

Pins the request to a dated API version. When omitted, the request uses the original (2025-01-01) request/response shapes, so existing unversioned callers are never broken. Generated SDKs always send the latest version they were built against. An unrecognized value is rejected with a 400. The schemas documented here always describe the latest version.

Example:

"2026-06-20"

Path Parameters

​
id
string
required

The ad group ID.

Response

200 - application/json

ad group unpaused

​
click_through_rate
number
required

Clicks divided by impressions, between 0 and 1.

​
clicks
number
required

The number of clicks.

​
cost_per_click
number
required

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

​
cost_per_lead
number | null
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 | null
required

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

​
frequency
number | null
required

Platform-reported impressions divided by reach.

​
impressions
number
required

The number of impressions.

​
leads
number
required

Whop pixel-attributed leads, last-click.

​
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.

​
return_on_ad_spend
number
required

Purchase value divided by spend; 0 when there is no spend.

​
spend
number
required

The amount charged, in spend_currency.

​
spend_currency
string | null
required

The ISO 4217 currency code of all monetary metrics.

​
unique_click_through_rate
number | null
required

Unique clicks divided by impressions, between 0 and 1.

​
unique_clicks
number
required

The number of unique clicks.

​
id
string
required

Unique identifier for the ad group.

​
title
string | null
required

The display title of the ad group.

​
status
enum<string>
required

Delivery status of the ad group.

Available options:
active,
paused,
rejected
Example:

"active"

​
optimization_goal
string | null
required

What the ad group optimizes for.

​
conversion_location
enum<string> | null
required

Where conversions happen.

Available options:
website,
null
Example:

"website"

​
conversion_event
required

The pixel event optimized for. A standard event, or any custom pixel event name.

Available options:
purchase,
add_to_cart,
initiated_checkout,
add_payment_info,
complete_registration,
lead,
content_view,
search,
contact,
customize_product,
donate,
find_location,
schedule,
start_trial,
submit_application,
subscribe
​
budget_amount
number | null
required

Ad-set budget; null when the campaign owns budget (CBO).

​
budget_type
enum<string> | null
required

Whether the budget is daily or lifetime.

Available options:
daily,
lifetime,
null
Example:

"daily"

​
minimum_daily_spend
number | null
required

Daily spend floor within the budget.

​
bid_type
enum<string> | null
required

Bid strategy.

Available options:
minimum_cost,
average_target,
maximum_target,
null
Example:

"minimum_cost"

​
desired_cost_per_result
number | null
required

Target/cap cost for average_target / maximum_target.

​
starts_at
string | null
required

Schedule start, ISO 8601.

​
ends_at
string | null
required

Schedule end, ISO 8601.

​
regions
object
required

Geo targeting: include/exclude countries, cities, zips.

​
audience
object
required

Demographic targeting: automatic (Advantage+), age range, gender.

​
devices
object
required

Device targeting: platforms and operating systems.

​
frequency_cap
object
required

Impression cap; only valid for reach optimization.

​
placements
object[]
required
​
ad_campaign
object
required

The ad campaign this ad group belongs to, an object with an id.

​
created_at
string
required

When the ad group was created, ISO 8601.

​
updated_at
string
required

When the ad group was last updated, ISO 8601.

​
issues
object[]
required