Ad Campaign

An advertising campaign running on an external platform or within Whop.

id · string · required

The unique identifier for the ad campaign.

Example:

"adcamp_xxxxxxxxxxx"

title · string · required

The title of the ad campaign

status · enum<string> · required

Current status of the campaign (active, paused, or inactive)

Available options: active, paused, inactive, stale, pending_refund

target_country_codes · string[] · required

Array of ISO3166 country codes for territory targeting

Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.

daily_budget · number | null · required

Effective daily budget in dollars — sum of ad group budgets when set, otherwise campaign-level daily budget

Example:

6.9

platform · enum<string> | null · required

The external platform this campaign is running on (e.g., meta, tiktok).

Available options: meta, tiktok

available_budget · number · required

Available budget in dollars, capped at daily budget minus today's spend for daily campaigns

Example:

6.9

created_at · string<date-time> · required

The datetime the ad campaign was created.

Example:

"2023-12-01T05:00:00.401Z"

updated_at · string<date-time> · required

The datetime the ad campaign was last updated.

Example:

"2023-12-01T05:00:00.401Z"

paused_until · string<date-time> | null · required

If temporarily paused, the timestamp when the campaign will auto-resume

Example:

"2023-12-01T05:00:00.401Z"

clicks_count · integer · required

Number of clicks

Example:

42

impressions_count · integer · required

Number of impressions (views)

Example:

42

purchases_count · integer · required

Number of purchases

Example:

42

remaining_balance · number · required

Remaining balance in dollars

Example:

6.9

revenue · number · required

Total revenue generated from users who converted through this campaign

Example:

6.9

return_on_ad_spend · number · required

Return on Ad Spend (ROAS) percentage - revenue generated divided by ad spend

Example:

6.9

todays_spend · number · required

Amount spent today in dollars

Example:

6.9

total_credits · number · required

Total credits added to the campaign in dollars

Example:

6.9

total_spend · number · required

Total amount spent on conversions in dollars

Example:

6.9

product · object · required

The access pass being promoted. Null for campaigns that don't target a specific product.

Show child attributes

created_by_user · object · required

The user who created the campaign

Show child attributes

payment_method · BasePaymentMethod · object · required

A saved payment method with no type-specific details available.

BasePaymentMethod

CardPaymentMethod

UsBankAccountPaymentMethod

CashappPaymentMethod

IdealPaymentMethod

SepaDebitPaymentMethod

Show child attributes

billing_ledger_account · object · required

The ledger account being charged for platform balance billing (null if using card)

Show child attributes

config · object · required

Unified campaign configuration (objective, budget, bidding, etc.).

Show child attributes