Skip to main content
PATCH
TypeScript

인증

Authorization
string
header
필수

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

헤더

Api-Version-Date
string

Pins the request to a dated API version.

예시:

"2026-11-17"

경로 매개변수

id
string
필수

The ad group ID.

본문

application/json
audiences
Audiences · object

Saved audiences to deliver to or exclude. Can't be combined with demographics.automatic.

bid_type
enum<string>

How delivery bids are set in the ad auction. Target-based strategies use desired_cost_per_result.

사용 가능한 옵션:
minimum_cost,
average_target,
maximum_target
예시:

"average_target"

budget_amount
number

This ad group's budget in USD, which is what it is stored and billed in. Omit when the budget is set on the campaign instead.

예시:

40

budget_amount_local
number

This ad group's 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; on an update, an amount equal to the current budget_amount_local keeps the stored USD budget as is. Provide this or budget_amount, not both.

budget_type
enum<string>

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

사용 가능한 옵션:
daily,
lifetime
예시:

"daily"

conversion_event

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

사용 가능한 옵션:
purchase,
add_to_cart,
initiated_checkout,
add_payment_info,
complete_registration,
lead,
content_view,
contact,
search,
customize_product,
donate,
find_location,
schedule,
start_trial,
submit_application,
subscribe
예시:

"purchase"

delivery_schedule
object | null

Hours the ad group delivers in each week, keyed by day. Each window runs from start to end on the hour, with 24:00 for midnight, and a day's windows can't overlap or touch. A day that's empty or left out doesn't deliver. Replaces the whole schedule; null delivers at every hour. Some platforms need a lifetime budget_type for a schedule, on the ad group or on its campaign when the campaign holds the budget.

예시:
demographics
Demographics · object

Age, gender, and automatic-audience targeting.

desired_cost_per_result
number

Cost per result to aim for (average_target) or never exceed (maximum_target).

예시:

35

devices
Devices · object

Device platforms and operating systems to target.

ends_at
string

When the ad group stops delivering, as an ISO 8601 timestamp. Omit to run until paused.

예시:

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

keywords
object[]

Search terms the ad group's ads can show for, and terms they never show for. Only search campaigns take keywords, and each of their ad groups needs at least one before launch. Replaces the stored list; omit to keep it.

languages
string[]

Languages to target, as ISO 639 codes such as en or es. Empty or omitted targets all languages.

regions
Regions · object

Locations to target and exclude.

starts_at
string

When the ad group starts delivering, as an ISO 8601 timestamp. Omit to start as soon as it's active.

예시:

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

status
enum<string>

Initial status (default: active).

사용 가능한 옵션:
active,
paused
예시:

"paused"

title
string

The display name of the ad group.

예시:

"North America — brand prospecting"

응답

ad group updated

ad_campaign
object
필수

The ad campaign this ad group belongs to.

added_to_cart_value
number
필수

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

예시:

12650

added_to_carts
number
필수

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

예시:

165

audiences
object
필수

Saved audiences this ad group delivers to or excludes.

bid_type
enum<string> | null
필수

How delivery bids are set in the ad auction. Target-based strategies use desired_cost_per_result.

사용 가능한 옵션:
minimum_cost,
average_target,
maximum_target,
null
예시:

"average_target"

budget_amount
number | null
필수

This ad group's budget in USD, which is what it is stored and billed in. null when the budget is set on the campaign instead.

예시:

60

budget_amount_local
number | null
필수

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.

예시:

60

budget_currency
string
필수

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

예시:

"usd"

budget_type
enum<string> | null
필수

Whether budget_amount is spent per day (daily) or over the ad group's full run (lifetime). A lifetime ad group also needs ends_at, at least 24 hours after it starts.

사용 가능한 옵션:
daily,
lifetime,
null
예시:

"daily"

click_through_rate
number
필수

Clicks divided by impressions, between 0 and 1.

예시:

0.025

clicks
number
필수

The number of clicks.

예시:

5500

completed_registration_value
number
필수

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

예시:

1650

completed_registrations
number
필수

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

예시:

55

contact_value
number
필수

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

예시:

2640

contacts
number
필수

Whop pixel-attributed contact events, last-click.

예시:

88

conversion_event
필수

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

사용 가능한 옵션:
purchase,
add_to_cart,
initiated_checkout,
add_payment_info,
complete_registration,
lead,
content_view,
contact,
search,
customize_product,
donate,
find_location,
schedule,
start_trial,
submit_application,
subscribe
예시:

"purchase"

cost_per_added_to_cart
number | null
필수

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

예시:

8

cost_per_click
number
필수

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

예시:

0.24

cost_per_completed_registration
number | null
필수

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

예시:

24

cost_per_contact
number | null
필수

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

예시:

15

cost_per_lead
number | null
필수

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

예시:

10

cost_per_mille
number
필수

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

예시:

6

cost_per_purchase
number | null
필수

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

예시:

30

cost_per_result
number | null
필수

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

예시:

40

cost_per_schedule
number | null
필수

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

예시:

22

cost_per_submitted_application
number | null
필수

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

예시:

120

cost_per_unique_click
number | null
필수

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

예시:

0.4

cost_per_viewed_content
number | null
필수

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

예시:

1.1

created_at
string
필수

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

예시:

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

custom_conversions
number
필수

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

예시:

41

custom_event_counts
object
필수

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
필수

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_schedule
object | null
필수

Hours the ad group delivers in each week, keyed by day. Days it doesn't deliver are omitted. null when it delivers at every hour. Some platforms need a lifetime budget_type for a schedule, on the ad group or on its campaign when the campaign holds the budget.

delivery_status
enum<string>
필수

Whether ads in this ad group are delivering right now, and if not, why. When several states apply at once, the highest-precedence one is returned.

사용 가능한 옵션:
all_ads_rejected,
rejected,
draft,
campaign_paused,
paused,
in_review,
processing,
revise_content,
issues,
scheduled,
completed,
learning,
active
예시:

"paused"

demographics
object
필수

Age, gender, and automatic-audience targeting.

desired_cost_per_result
number | null
필수

Cost per result to aim for (average_target) or never exceed (maximum_target). null for minimum_cost bidding.

예시:

40

devices
object
필수

Device platforms and operating systems targeted.

ends_at
string | null
필수

When the ad group stops delivering, as an ISO 8601 timestamp. null when it runs until paused.

예시:

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

frequency
number | null
필수

Impressions divided by reach.

예시:

null

id
string
필수

Unique identifier for the ad group, prefixed adgrp_.

예시:

"adgrp_xxxxxxxxxxxxxx"

impressions
number
필수

The number of impressions.

예시:

220000

issues
object[]
필수
languages
string[]
필수

Languages targeted, as ISO 639 codes such as en or es. A region-specific locale with no ISO code appears as a numeric locale key. Empty targets all languages.

lead_value
number
필수

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

예시:

3960

leads
number
필수

Whop pixel-attributed leads, last-click.

예시:

132

learning_progress
object | null
필수

Progress toward the conversions this ad group's learning phase needs. Null unless it is learning or learning limited and valid counts are available. Reaching the threshold does not determine delivery status.

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

예시:

4400

purchase_value
number
필수

USD value of pixel-attributed purchases.

예시:

7920

purchases
number
필수

Whop pixel-attributed purchases, last-click.

예시:

44

reach
number
필수

The number of unique people who saw this.

예시:

0

regions
object
필수

Locations targeted and excluded.

result_event
enum<string> | null
필수

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.

사용 가능한 옵션:
purchase,
lead,
schedule,
submit_application,
contact,
complete_registration,
view_content,
add_to_cart,
custom,
messaging_conversation,
null
예시:

"custom"

result_event_name
string | null
필수

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

예시:

"quote_requested"

results
number | null
필수

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.

예시:

33

return_on_ad_spend
number
필수

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

예시:

6

schedule_value
number
필수

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

예시:

5400

schedules
number
필수

Whop pixel-attributed schedule events, last-click.

예시:

60

spend
number
필수

The amount charged, in spend_currency.

예시:

1320

spend_currency
string | null
필수

The ISO 4217 currency code of all monetary metrics.

예시:

"usd"

starts_at
string | null
필수

When the ad group starts delivering, as an ISO 8601 timestamp. null when it starts as soon as it's active.

예시:

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

status
enum<string>
필수

Whether the ad group is enabled. active and paused are set by you; rejected means it failed ad review; duplicating is a copy still being filled in.

사용 가능한 옵션:
active,
paused,
rejected,
duplicating
예시:

"active"

submitted_application_value
number
필수

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

예시:

1320

submitted_applications
number
필수

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

예시:

11

title
string | null
필수

Display name of the ad group.

예시:

"Austin ceramic coating — repeat customers"

unique_click_through_rate
number | null
필수

Unique clicks divided by impressions, between 0 and 1.

예시:

null

unique_clicks
number
필수

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

예시:

3300

updated_at
string
필수

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

예시:

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

viewed_content_value
number
필수

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

예시:

8400

viewed_contents
number
필수

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

예시:

1200

keywords
object[]