Ad Campaign - Whop Docs

{
  "id": "adcamp_xxxxxxxxxxx",
  "title": "<string>",
  "created_at": "2023-12-01T05:00:00.401Z",
  "updated_at": "2023-12-01T05:00:00.401Z",
  "total_spend": 6.9,
  "budget": 6.9,
  "created_by_user": {
    "id": "user_xxxxxxxxxxxxx",
    "name": "John Doe",
    "username": "johndoe42"
  },
  "meta_config": {
    "bid_amount": 42,
    "special_categories": [
      "<string>"
    ],
    "budget_optimization": true,
    "start_time": "<string>",
    "end_time": "<string>"
  }
}

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

string

required

The unique identifier for this ad campaign.

Example:

"adcamp_xxxxxxxxxxx"

title

string

required

The campaign name shown in the Whop dashboard.

status

enum<string>

required

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

Available options:

active,

paused,

payment_failed,

draft,

in_review,

flagged

platform

enum<string>

required

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

Available options:

meta,

tiktok

created_at

string<date-time>

required

When the ad campaign was created.

Example:

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

updated_at

string<date-time>

required

When the ad campaign was last updated.

Example:

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

total_spend

number

required

Total amount spent in dollars.

Example:

6.9

budget

number | null

required

Total budget in dollars.

Example:

6.9

budget_type

enum<string> | null

required

How the budget is allocated (daily or lifetime).

Available options:

daily,

lifetime

created_by_user

object

required

The user who created this ad campaign.

Show child attributes

meta_config

object

required

Meta-specific campaign configuration (objective, budget mode, etc.). Null for non-Meta campaigns.

Show child attributes

Update webhook

List ad campaigns

⌘I

Documentation Index