Skip to main content
POST
/
ads
/
{id}
/
pause
Pause an Ad
curl --request POST \
  --url https://{defaultHost}/ads/{id}/pause \
  --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",
  "primary_texts": [
    "<string>"
  ],
  "headlines": [
    "<string>"
  ],
  "descriptions": [
    "<string>"
  ],
  "call_to_action": "learn_more",
  "url": "<string>",
  "url_parameters": {},
  "ad_group": {},
  "ad_campaign": {},
  "creatives": [
    {}
  ],
  "social_accounts": [
    {}
  ],
  "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 ID.

Response

200 - application/json

ad paused

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

​
title
string | null
required

The display title of the ad. Falls back to the creative set caption when unset.

​
status
enum<string>
required

The delivery status of the ad.

Available options:
active,
paused,
in_review,
rejected
Example:

"active"

​
primary_texts
string[]
required

The primary text variants shown in the ad body.

​
headlines
string[]
required

The headline variants shown on the ad.

​
descriptions
string[]
required

The description variants shown on the ad.

​
call_to_action
enum<string> | null
required

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

Available options:
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
Example:

"learn_more"

​
url
string | null
required

The URL the ad links to.

​
url_parameters
object
required

Query parameters appended to the URL, as a string-to-string map.

​
ad_group
object
required

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

​
ad_campaign
object
required

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

​
creatives
object[]
required
​
social_accounts
object[]
required
​
created_at
string
required

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

​
updated_at
string
required

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

​
issues
object[]
required