@whop/cli 0.16.0 → 0.16.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -3
- package/dist/index.js +6647 -15750
- package/dist/index.js.map +1 -1
- package/dist/vite-devtools-stub.d.ts +22 -0
- package/dist/vite-devtools-stub.js +19 -0
- package/dist/vite-devtools-stub.js.map +1 -0
- package/dist/vite.d.ts +17 -2
- package/dist/vite.js +30 -5
- package/dist/vite.js.map +1 -1
- package/package.json +8 -7
- package/skills/whop/SKILL.md +48 -0
- package/skills/whop/references/ads.md +43 -0
- package/skills/whop/references/formation.md +40 -0
- package/skills/whop/references/websites.md +59 -0
- package/skills/whop-accounts/SKILL.md +0 -228
- package/skills/whop-ad-campaigns/SKILL.md +0 -204
- package/skills/whop-ad-groups/SKILL.md +0 -269
- package/skills/whop-ads/SKILL.md +0 -277
- package/skills/whop-api-keys/SKILL.md +0 -126
- package/skills/whop-app-builds/SKILL.md +0 -81
- package/skills/whop-apps/SKILL.md +0 -161
- package/skills/whop-audiences/SKILL.md +0 -105
- package/skills/whop-bounties/SKILL.md +0 -145
- package/skills/whop-bounty-submissions/SKILL.md +0 -95
- package/skills/whop-cards/SKILL.md +0 -133
- package/skills/whop-checkout-configurations/SKILL.md +0 -77
- package/skills/whop-deposits/SKILL.md +0 -26
- package/skills/whop-dispute-alerts/SKILL.md +0 -42
- package/skills/whop-disputes/SKILL.md +0 -99
- package/skills/whop-events/SKILL.md +0 -105
- package/skills/whop-exports/SKILL.md +0 -379
- package/skills/whop-ledgers/SKILL.md +0 -52
- package/skills/whop-media/SKILL.md +0 -44
- package/skills/whop-members/SKILL.md +0 -64
- package/skills/whop-memberships/SKILL.md +0 -165
- package/skills/whop-notifications/SKILL.md +0 -104
- package/skills/whop-partners/SKILL.md +0 -113
- package/skills/whop-payment-method-domains/SKILL.md +0 -93
- package/skills/whop-payments/SKILL.md +0 -40
- package/skills/whop-payouts/SKILL.md +0 -167
- package/skills/whop-people/SKILL.md +0 -63
- package/skills/whop-permissions/SKILL.md +0 -21
- package/skills/whop-plans/SKILL.md +0 -165
- package/skills/whop-products/SKILL.md +0 -153
- package/skills/whop-recommended-actions/SKILL.md +0 -59
- package/skills/whop-resolution-center-cases/SKILL.md +0 -233
- package/skills/whop-setup-intents/SKILL.md +0 -40
- package/skills/whop-shipments/SKILL.md +0 -79
- package/skills/whop-social-accounts/SKILL.md +0 -128
- package/skills/whop-stats/SKILL.md +0 -65
- package/skills/whop-swaps/SKILL.md +0 -77
- package/skills/whop-team-members/SKILL.md +0 -93
- package/skills/whop-transfers/SKILL.md +0 -80
- package/skills/whop-users/SKILL.md +0 -309
- package/skills/whop-verifications/SKILL.md +0 -67
|
@@ -1,204 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: whop-ad-campaigns
|
|
3
|
-
description: Platform, objective, and budget for a set of ads. Run `whop ad-campaigns --help` for usage details.
|
|
4
|
-
requires_bin: whop
|
|
5
|
-
command: whop ad-campaigns
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
An Ad Campaign is the top-level container for paid ads on an ad network. It sets the platform, objective, and budget strategy shared by its [ad groups](https://docs.whop.com/api-reference/beta/ad-groups/ad-group) and ads.
|
|
9
|
-
|
|
10
|
-
Use the Ad Campaigns API to create campaigns, list campaigns for an account, retrieve or update campaign settings, and pause or resume campaign delivery.
|
|
11
|
-
|
|
12
|
-
# whop ad-campaigns create
|
|
13
|
-
|
|
14
|
-
Create an Ad Campaign
|
|
15
|
-
|
|
16
|
-
## Options
|
|
17
|
-
|
|
18
|
-
| Flag | Type | Required | Default | Description |
|
|
19
|
-
|------|------|----------|---------|-------------|
|
|
20
|
-
| `--account_id` | `string` | no | | The account to create the campaign under. Defaults to the account-scoped key's own account. |
|
|
21
|
-
| `--bid_type` | `string` | no | | How delivery bids in the ad auction: `minimum_cost` gets the most results for the budget, `average_target` holds an average cost per result, `maximum_target` never bids above a cap. Only for campaigns that own the budget. |
|
|
22
|
-
| `--budget_amount` | `number` | no | | The campaign's budget, in the ad account's currency. Required when budget_optimization is `ad_campaign`; omit when each ad group sets its own budget. |
|
|
23
|
-
| `--budget_optimization` | `string` | no | | Which level owns the budget: the whole campaign (`ad_campaign`) or each ad group individually (`ad_group`). Defaults to `ad_group`. |
|
|
24
|
-
| `--budget_type` | `string` | no | | Whether the budget is spent per day (`daily`) or over the campaign's full run (`lifetime`). Defaults to `daily`. |
|
|
25
|
-
| `--desired_cost_per_result` | `number` | no | | Cost per result to aim for (`average_target`) or never exceed (`maximum_target`). Only for campaigns that own the budget. |
|
|
26
|
-
| `--ends_at` | `string` | no | | When the campaign stops delivering, as an ISO 8601 timestamp. Only for campaigns that own the budget. |
|
|
27
|
-
| `--objective` | `string` | yes | | The goal the campaign optimizes toward. |
|
|
28
|
-
| `--platform` | `string` | yes | | The ad network the campaign runs on. |
|
|
29
|
-
| `--special_ad_categories` | `array` | no | | Regulated categories the campaign falls under. Ads in these categories are subject to extra targeting restrictions. |
|
|
30
|
-
| `--starts_at` | `string` | no | | When the campaign starts delivering, as an ISO 8601 timestamp. Only for campaigns that own the budget. |
|
|
31
|
-
| `--title` | `string` | yes | | The title of the campaign. |
|
|
32
|
-
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
33
|
-
|
|
34
|
-
> Confirm with the user before executing this destructive command.
|
|
35
|
-
|
|
36
|
-
---
|
|
37
|
-
|
|
38
|
-
# whop ad-campaigns delete
|
|
39
|
-
|
|
40
|
-
Delete an Ad Campaign
|
|
41
|
-
|
|
42
|
-
## Arguments
|
|
43
|
-
|
|
44
|
-
| Name | Type | Required | Description |
|
|
45
|
-
|------|------|----------|-------------|
|
|
46
|
-
| `id` | `string` | yes | The ad campaign ID. |
|
|
47
|
-
|
|
48
|
-
> Confirm with the user before executing this destructive command.
|
|
49
|
-
|
|
50
|
-
---
|
|
51
|
-
|
|
52
|
-
# whop ad-campaigns duplicate
|
|
53
|
-
|
|
54
|
-
Duplicate an Ad Campaign
|
|
55
|
-
|
|
56
|
-
## Arguments
|
|
57
|
-
|
|
58
|
-
| Name | Type | Required | Description |
|
|
59
|
-
|------|------|----------|-------------|
|
|
60
|
-
| `id` | `string` | yes | The ad campaign ID. |
|
|
61
|
-
|
|
62
|
-
## Options
|
|
63
|
-
|
|
64
|
-
| Flag | Type | Required | Default | Description |
|
|
65
|
-
|------|------|----------|---------|-------------|
|
|
66
|
-
| `--count` | `number` | no | | Number of copies to create (1-10). Defaults to 1. |
|
|
67
|
-
| `--preserve_engagement` | `boolean` | no | | Whether the copied ads keep the original posts' engagement (likes, comments, shares). Defaults to false. |
|
|
68
|
-
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
69
|
-
|
|
70
|
-
> Confirm with the user before executing this destructive command.
|
|
71
|
-
|
|
72
|
-
---
|
|
73
|
-
|
|
74
|
-
# whop ad-campaigns get
|
|
75
|
-
|
|
76
|
-
Retrieve an Ad Campaign
|
|
77
|
-
|
|
78
|
-
## Arguments
|
|
79
|
-
|
|
80
|
-
| Name | Type | Required | Description |
|
|
81
|
-
|------|------|----------|-------------|
|
|
82
|
-
| `id` | `string` | yes | The ad campaign ID. |
|
|
83
|
-
|
|
84
|
-
## Options
|
|
85
|
-
|
|
86
|
-
| Flag | Type | Required | Default | Description |
|
|
87
|
-
|------|------|----------|---------|-------------|
|
|
88
|
-
| `--stats_from` | `string` | no | | Start of the stats window. |
|
|
89
|
-
| `--stats_to` | `string` | no | | End of the stats window. |
|
|
90
|
-
| `--time_zone` | `string` | no | | IANA timezone the stats window is interpreted in. Defaults to UTC. |
|
|
91
|
-
| `--attribution_model` | `string` | no | | Attribution model the conversion stats count under (defaults to last_touch). Under both models a journey with any whop ad touch attributes to whop; the model picks which whop touch credits the entity and which non-whop source wins otherwise. |
|
|
92
|
-
|
|
93
|
-
---
|
|
94
|
-
|
|
95
|
-
# whop ad-campaigns list
|
|
96
|
-
|
|
97
|
-
List Ad Campaigns
|
|
98
|
-
|
|
99
|
-
## Options
|
|
100
|
-
|
|
101
|
-
| Flag | Type | Required | Default | Description |
|
|
102
|
-
|------|------|----------|---------|-------------|
|
|
103
|
-
| `--account_id` | `string` | no | | The account the campaigns belong to. Defaults to the account-scoped key's own account. |
|
|
104
|
-
| `--status` | `string` | no | | Only return campaigns with this status. |
|
|
105
|
-
| `--query` | `string` | no | | Filter campaigns by a title or ID substring. |
|
|
106
|
-
| `--order` | `string` | no | | The field to sort by. Defaults to created_at. Stat columns (spend, impressions, …) rank over the stats_from/stats_to window across the whole list, not just the current page. results, cost_per_result and return_on_ad_spend rank by the same Whop pixel-attributed values the response reports. |
|
|
107
|
-
| `--direction` | `string` | no | | The sort direction. Defaults to desc. |
|
|
108
|
-
| `--created_before` | `string` | no | | Only return campaigns created before this timestamp. |
|
|
109
|
-
| `--created_after` | `string` | no | | Only return campaigns created after this timestamp. |
|
|
110
|
-
| `--stats_from` | `string` | no | | Start of the stats window. Defaults to all-time. |
|
|
111
|
-
| `--stats_to` | `string` | no | | End of the stats window. Defaults to now. |
|
|
112
|
-
| `--time_zone` | `string` | no | | IANA timezone (e.g. America/New_York) the stats window is interpreted in. Bare stats_from/stats_to dates resolve to day boundaries on this clock. Defaults to UTC. |
|
|
113
|
-
| `--attribution_model` | `string` | no | | Attribution model the conversion stats count under (defaults to last_touch). Under both models a journey with any whop ad touch attributes to whop; the model picks which whop touch credits the entity and which non-whop source wins otherwise. |
|
|
114
|
-
| `--first` | `number` | no | `20` | The number of campaigns to return. |
|
|
115
|
-
| `--after` | `string` | no | | Cursor to fetch the page after (from page_info.end_cursor). |
|
|
116
|
-
| `--last` | `number` | no | | The number of campaigns to return from the end of the range. |
|
|
117
|
-
| `--before` | `string` | no | | Cursor to fetch the page before (from page_info.start_cursor). |
|
|
118
|
-
|
|
119
|
-
---
|
|
120
|
-
|
|
121
|
-
# whop ad-campaigns pause
|
|
122
|
-
|
|
123
|
-
Pause an Ad Campaign
|
|
124
|
-
|
|
125
|
-
## Arguments
|
|
126
|
-
|
|
127
|
-
| Name | Type | Required | Description |
|
|
128
|
-
|------|------|----------|-------------|
|
|
129
|
-
| `id` | `string` | yes | The ad campaign ID. |
|
|
130
|
-
|
|
131
|
-
## Options
|
|
132
|
-
|
|
133
|
-
| Flag | Type | Required | Default | Description |
|
|
134
|
-
|------|------|----------|---------|-------------|
|
|
135
|
-
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
136
|
-
|
|
137
|
-
> Confirm with the user before executing this destructive command.
|
|
138
|
-
|
|
139
|
-
---
|
|
140
|
-
|
|
141
|
-
# whop ad-campaigns retry_payment
|
|
142
|
-
|
|
143
|
-
Retry a Failed Ad Campaign Payment
|
|
144
|
-
|
|
145
|
-
## Arguments
|
|
146
|
-
|
|
147
|
-
| Name | Type | Required | Description |
|
|
148
|
-
|------|------|----------|-------------|
|
|
149
|
-
| `id` | `string` | yes | The ad campaign ID. |
|
|
150
|
-
|
|
151
|
-
## Options
|
|
152
|
-
|
|
153
|
-
| Flag | Type | Required | Default | Description |
|
|
154
|
-
|------|------|----------|---------|-------------|
|
|
155
|
-
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
156
|
-
|
|
157
|
-
> Confirm with the user before executing this destructive command.
|
|
158
|
-
|
|
159
|
-
---
|
|
160
|
-
|
|
161
|
-
# whop ad-campaigns unpause
|
|
162
|
-
|
|
163
|
-
Unpause an Ad Campaign
|
|
164
|
-
|
|
165
|
-
## Arguments
|
|
166
|
-
|
|
167
|
-
| Name | Type | Required | Description |
|
|
168
|
-
|------|------|----------|-------------|
|
|
169
|
-
| `id` | `string` | yes | The ad campaign ID. |
|
|
170
|
-
|
|
171
|
-
## Options
|
|
172
|
-
|
|
173
|
-
| Flag | Type | Required | Default | Description |
|
|
174
|
-
|------|------|----------|---------|-------------|
|
|
175
|
-
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
176
|
-
|
|
177
|
-
> Confirm with the user before executing this destructive command.
|
|
178
|
-
|
|
179
|
-
---
|
|
180
|
-
|
|
181
|
-
# whop ad-campaigns update
|
|
182
|
-
|
|
183
|
-
Update an Ad Campaign
|
|
184
|
-
|
|
185
|
-
## Arguments
|
|
186
|
-
|
|
187
|
-
| Name | Type | Required | Description |
|
|
188
|
-
|------|------|----------|-------------|
|
|
189
|
-
| `id` | `string` | yes | The ad campaign ID. |
|
|
190
|
-
|
|
191
|
-
## Options
|
|
192
|
-
|
|
193
|
-
| Flag | Type | Required | Default | Description |
|
|
194
|
-
|------|------|----------|---------|-------------|
|
|
195
|
-
| `--bid_type` | `string` | no | | How delivery bids in the ad auction: `minimum_cost` gets the most results for the budget, `average_target` holds an average cost per result, `maximum_target` never bids above a cap. Switching to `minimum_cost` clears the cap amounts stored on the campaign's ad groups. Only for campaigns that own the budget. |
|
|
196
|
-
| `--budget_amount` | `number` | no | | The campaign budget, in the account's currency. Interpreted as daily or lifetime per the campaign's existing budget type. |
|
|
197
|
-
| `--budget_optimization` | `string` | no | | Which level owns the budget: the whole campaign (`ad_campaign`) or each ad group individually (`ad_group`). Only changeable before the campaign is live on the ad network; switching to `ad_campaign` requires budget_amount in the same request, and switching to `ad_group` clears the campaign budget. |
|
|
198
|
-
| `--ends_at` | `string` | no | | When the campaign stops delivering, as an ISO 8601 timestamp. Only for campaigns that own the budget. |
|
|
199
|
-
| `--special_ad_categories` | `array` | no | | Regulated categories the campaign falls under. Editable on any campaign, draft or launched; pass an empty array to clear. |
|
|
200
|
-
| `--starts_at` | `string` | no | | When the campaign starts delivering, as an ISO 8601 timestamp. Only for campaigns that own the budget. |
|
|
201
|
-
| `--status` | `string` | no | | Set to active to launch a draft campaign (moderates and pushes it live). Live-campaign pause and resume use the pause and unpause actions. |
|
|
202
|
-
| `--title` | `string` | no | | The name of the campaign. |
|
|
203
|
-
|
|
204
|
-
> Confirm with the user before executing this destructive command.
|
|
@@ -1,269 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: whop-ad-groups
|
|
3
|
-
description: Audience, placements, and schedule within a campaign. Run `whop ad-groups --help` for usage details.
|
|
4
|
-
requires_bin: whop
|
|
5
|
-
command: whop ad-groups
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
An Ad Group sits inside an [ad campaign](https://docs.whop.com/api-reference/beta/ad-campaigns/ad-campaign) and controls delivery for [ads](https://docs.whop.com/api-reference/beta/ads/ad). It sets the audience, placements, schedule, budget, and optimization goal for its ads.
|
|
9
|
-
|
|
10
|
-
Use the Ad Groups API to create ad groups in campaigns, list or retrieve targeting and delivery settings, update budgets or targeting, delete groups that should stop running, and pause or resume delivery. It can also search the ad platform's targeting taxonomy for options to target and estimate how many people a draft targeting spec can reach.
|
|
11
|
-
|
|
12
|
-
# whop ad-groups create
|
|
13
|
-
|
|
14
|
-
Create an Ad Group
|
|
15
|
-
|
|
16
|
-
## Options
|
|
17
|
-
|
|
18
|
-
| Flag | Type | Required | Default | Description |
|
|
19
|
-
|------|------|----------|---------|-------------|
|
|
20
|
-
| `--ad_campaign_id` | `string` | yes | | The ad campaign to create the ad group in, prefixed `adcamp_`. |
|
|
21
|
-
| `--audiences` | `object` | no | | Saved audiences to deliver to or exclude. Can't be combined with demographics.automatic. |
|
|
22
|
-
| `--bid_type` | `string` | no | | How delivery bids are set in the ad auction. Target-based strategies use `desired_cost_per_result`. |
|
|
23
|
-
| `--budget_amount` | `number` | no | | This ad group's budget, in the ad account's currency. Omit when the budget is set on the campaign instead. |
|
|
24
|
-
| `--budget_type` | `string` | no | | Whether budget_amount is spent per day (`daily`) or over the ad group's full run (`lifetime`). |
|
|
25
|
-
| `--conversion_event` | `unknown` | no | | The pixel event optimized for. A standard event, or any custom pixel event name. |
|
|
26
|
-
| `--conversion_location` | `string` | no | | Where the outcome being optimized for occurs, such as a website visit, social-profile visit, messaging conversation, ad interaction, or lead-form submission. The lead form itself is set on the ad. |
|
|
27
|
-
| `--demographics` | `object` | no | | Age, gender, and automatic-audience targeting. |
|
|
28
|
-
| `--desired_cost_per_result` | `number` | no | | Cost per result to aim for (`average_target`) or never exceed (`maximum_target`). |
|
|
29
|
-
| `--detailed_targeting` | `object` | no | | Interest, behavior, and demographic targeting, using categories from the ad platform's targeting taxonomy. Entries across interests, behaviors, and demographics are OR'd together (anyone matching any entry is reached), matching Ads Manager's detailed-targeting box. At most 100 entries per section. Can't be combined with demographics.automatic, and unavailable to campaigns with special_ad_categories. |
|
|
30
|
-
| `--devices` | `object` | no | | Device platforms and operating systems to target. |
|
|
31
|
-
| `--dynamic_creative` | `boolean` | no | | Let the ad platform automatically mix and match this ad group's creatives and copy to find the best-performing combinations. Set at creation; can't be changed afterward. |
|
|
32
|
-
| `--ends_at` | `string` | no | | When the ad group stops delivering, as an ISO 8601 timestamp. Omit to run until paused. |
|
|
33
|
-
| `--frequency_cap` | `object` | no | | Cap on how often one person sees ads from this ad group. Only available on campaigns with the `awareness` objective. |
|
|
34
|
-
| `--languages` | `array` | no | | Languages to target, as ISO 639 codes such as `en` or `es`. Empty or omitted targets all languages. |
|
|
35
|
-
| `--message_apps` | `array` | no | | Apps the conversation opens in. Required when setting `conversion_location` to `messaging`, and rejected unless the ad group's conversion location is `messaging`. |
|
|
36
|
-
| `--minimum_daily_spend` | `number` | no | | Minimum the ad group tries to spend each day. |
|
|
37
|
-
| `--optimization_goal` | `string` | no | | The result the ad group's delivery is optimized to get the most of. |
|
|
38
|
-
| `--placements` | `unknown` | no | | `automatic` to let the ad platform choose placements, or the list of platforms and positions to target. Omit a platform's positions to target all of them.
|
|
39
|
-
|
|
40
|
-
Valid positions per platform:
|
|
41
|
-
|
|
42
|
-
- `facebook`: `feed`, `right_hand_column`, `marketplace`, `search`, `profile_feed`, `notification`, `story`, `instream_video`, `facebook_reels`, `facebook_reels_overlay`, `biz_disco_feed`
|
|
43
|
-
- `instagram`: `stream`, `story`, `explore`, `explore_home`, `reels`, `profile_feed`, `profile_reels`, `ig_search`
|
|
44
|
-
- `messenger`: `story`
|
|
45
|
-
- `audience_network`: `classic`, `rewarded_video`
|
|
46
|
-
- `threads`: `threads_stream`
|
|
47
|
-
- `whatsapp`: `status` |
|
|
48
|
-
| `--regions` | `object` | no | | Locations to target and exclude. |
|
|
49
|
-
| `--starts_at` | `string` | no | | When the ad group starts delivering, as an ISO 8601 timestamp. Omit to start as soon as it's active. |
|
|
50
|
-
| `--status` | `string` | no | | Initial status (default: `active`). |
|
|
51
|
-
| `--title` | `string` | no | | The display name of the ad group. |
|
|
52
|
-
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
53
|
-
|
|
54
|
-
> Confirm with the user before executing this destructive command.
|
|
55
|
-
|
|
56
|
-
---
|
|
57
|
-
|
|
58
|
-
# whop ad-groups delete
|
|
59
|
-
|
|
60
|
-
Delete an Ad Group
|
|
61
|
-
|
|
62
|
-
## Arguments
|
|
63
|
-
|
|
64
|
-
| Name | Type | Required | Description |
|
|
65
|
-
|------|------|----------|-------------|
|
|
66
|
-
| `id` | `string` | yes | The ad group ID. |
|
|
67
|
-
|
|
68
|
-
> Confirm with the user before executing this destructive command.
|
|
69
|
-
|
|
70
|
-
---
|
|
71
|
-
|
|
72
|
-
# whop ad-groups duplicate
|
|
73
|
-
|
|
74
|
-
Duplicate an Ad Group
|
|
75
|
-
|
|
76
|
-
## Arguments
|
|
77
|
-
|
|
78
|
-
| Name | Type | Required | Description |
|
|
79
|
-
|------|------|----------|-------------|
|
|
80
|
-
| `id` | `string` | yes | The ad group ID. |
|
|
81
|
-
|
|
82
|
-
## Options
|
|
83
|
-
|
|
84
|
-
| Flag | Type | Required | Default | Description |
|
|
85
|
-
|------|------|----------|---------|-------------|
|
|
86
|
-
| `--count` | `number` | no | | Number of copies to create (1-10). Defaults to 1. |
|
|
87
|
-
| `--preserve_engagement` | `boolean` | no | | Whether the copied ads keep the original posts' engagement (likes, comments, shares). Defaults to false. |
|
|
88
|
-
| `--target_ad_campaign_id` | `string` | no | | Campaign to duplicate into. Defaults to the ad group's own campaign. |
|
|
89
|
-
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
90
|
-
|
|
91
|
-
> Confirm with the user before executing this destructive command.
|
|
92
|
-
|
|
93
|
-
---
|
|
94
|
-
|
|
95
|
-
# whop ad-groups estimate_reach
|
|
96
|
-
|
|
97
|
-
Estimate Ad Group Reach
|
|
98
|
-
|
|
99
|
-
## Options
|
|
100
|
-
|
|
101
|
-
| Flag | Type | Required | Default | Description |
|
|
102
|
-
|------|------|----------|---------|-------------|
|
|
103
|
-
| `--account_id` | `string` | no | | Account to estimate on behalf of. Defaults to the authenticated account. |
|
|
104
|
-
| `--audiences` | `object` | no | | Saved audiences to deliver to or exclude. Can't be combined with demographics.automatic. |
|
|
105
|
-
| `--demographics` | `object` | no | | Age, gender, and automatic-audience targeting. |
|
|
106
|
-
| `--detailed_targeting` | `object` | no | | Interest, behavior, and demographic targeting, using categories from the ad platform's targeting taxonomy. Entries across interests, behaviors, and demographics are OR'd together (anyone matching any entry is reached), matching Ads Manager's detailed-targeting box. At most 100 entries per section. Can't be combined with demographics.automatic, and unavailable to campaigns with special_ad_categories. |
|
|
107
|
-
| `--devices` | `object` | no | | Device platforms and operating systems to target. |
|
|
108
|
-
| `--languages` | `array` | no | | Languages to target, as ISO 639 codes such as `en` or `es`. Empty or omitted targets all languages. |
|
|
109
|
-
| `--platform` | `string` | yes | | The ad network the estimate runs on. |
|
|
110
|
-
| `--regions` | `object` | no | | Locations to target and exclude. |
|
|
111
|
-
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
112
|
-
|
|
113
|
-
> Confirm with the user before executing this destructive command.
|
|
114
|
-
|
|
115
|
-
---
|
|
116
|
-
|
|
117
|
-
# whop ad-groups get
|
|
118
|
-
|
|
119
|
-
Retrieve an Ad Group
|
|
120
|
-
|
|
121
|
-
## Arguments
|
|
122
|
-
|
|
123
|
-
| Name | Type | Required | Description |
|
|
124
|
-
|------|------|----------|-------------|
|
|
125
|
-
| `id` | `string` | yes | The ad group ID. |
|
|
126
|
-
|
|
127
|
-
## Options
|
|
128
|
-
|
|
129
|
-
| Flag | Type | Required | Default | Description |
|
|
130
|
-
|------|------|----------|---------|-------------|
|
|
131
|
-
| `--stats_from` | `string` | no | | Start of the stats window. |
|
|
132
|
-
| `--stats_to` | `string` | no | | End of the stats window. |
|
|
133
|
-
| `--time_zone` | `string` | no | | IANA timezone the stats window is interpreted in. Defaults to UTC. |
|
|
134
|
-
| `--attribution_model` | `string` | no | | Attribution model the conversion stats count under (defaults to last_touch). Under both models a journey with any whop ad touch attributes to whop; the model picks which whop touch credits the entity and which non-whop source wins otherwise. |
|
|
135
|
-
|
|
136
|
-
---
|
|
137
|
-
|
|
138
|
-
# whop ad-groups list
|
|
139
|
-
|
|
140
|
-
List Ad Groups
|
|
141
|
-
|
|
142
|
-
## Options
|
|
143
|
-
|
|
144
|
-
| Flag | Type | Required | Default | Description |
|
|
145
|
-
|------|------|----------|---------|-------------|
|
|
146
|
-
| `--account_id` | `string` | no | | Account whose ad groups to list. Defaults to the authenticated account. |
|
|
147
|
-
| `--ad_campaign_id` | `string` | no | | Filter to ad groups in this campaign. |
|
|
148
|
-
| `--ad_campaign_ids` | `array` | no | | Filter to ad groups in these campaigns (max 100). Repeat the parameter for each id (ad_campaign_ids=a&ad_campaign_ids=b). |
|
|
149
|
-
| `--status` | `string` | no | | Filter to ad groups with this status. |
|
|
150
|
-
| `--query` | `string` | no | | Filter ad groups by a title or ID substring. |
|
|
151
|
-
| `--order` | `string` | no | | The field to sort by. Defaults to created_at. Stat columns (spend, impressions, …) rank over the stats_from/stats_to window across the whole list, not just the current page. results, cost_per_result and return_on_ad_spend rank by the same Whop pixel-attributed values the response reports. |
|
|
152
|
-
| `--direction` | `string` | no | | The sort direction. Defaults to desc. |
|
|
153
|
-
| `--created_before` | `string` | no | | Only return ad groups created before this timestamp. |
|
|
154
|
-
| `--created_after` | `string` | no | | Only return ad groups created after this timestamp. |
|
|
155
|
-
| `--stats_from` | `string` | no | | Start of the stats window. Defaults to all-time. |
|
|
156
|
-
| `--stats_to` | `string` | no | | End of the stats window. Defaults to now. |
|
|
157
|
-
| `--time_zone` | `string` | no | | IANA timezone (e.g. America/New_York) the stats window is interpreted in. Bare stats_from/stats_to dates resolve to day boundaries on this clock. Defaults to UTC. |
|
|
158
|
-
| `--attribution_model` | `string` | no | | Attribution model the conversion stats count under (defaults to last_touch). Under both models a journey with any whop ad touch attributes to whop; the model picks which whop touch credits the entity and which non-whop source wins otherwise. |
|
|
159
|
-
| `--first` | `number` | no | `20` | The number of ad groups to return. |
|
|
160
|
-
| `--after` | `string` | no | | Cursor to fetch the page after (from page_info.end_cursor). |
|
|
161
|
-
| `--last` | `number` | no | | The number of ad groups to return from the end of the range. |
|
|
162
|
-
| `--before` | `string` | no | | Cursor to fetch the page before (from page_info.start_cursor). |
|
|
163
|
-
|
|
164
|
-
---
|
|
165
|
-
|
|
166
|
-
# whop ad-groups pause
|
|
167
|
-
|
|
168
|
-
Pause an Ad Group
|
|
169
|
-
|
|
170
|
-
## Arguments
|
|
171
|
-
|
|
172
|
-
| Name | Type | Required | Description |
|
|
173
|
-
|------|------|----------|-------------|
|
|
174
|
-
| `id` | `string` | yes | The ad group ID. |
|
|
175
|
-
|
|
176
|
-
## Options
|
|
177
|
-
|
|
178
|
-
| Flag | Type | Required | Default | Description |
|
|
179
|
-
|------|------|----------|---------|-------------|
|
|
180
|
-
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
181
|
-
|
|
182
|
-
> Confirm with the user before executing this destructive command.
|
|
183
|
-
|
|
184
|
-
---
|
|
185
|
-
|
|
186
|
-
# whop ad-groups targeting_options
|
|
187
|
-
|
|
188
|
-
Search Targeting Options
|
|
189
|
-
|
|
190
|
-
## Options
|
|
191
|
-
|
|
192
|
-
| Flag | Type | Required | Default | Description |
|
|
193
|
-
|------|------|----------|---------|-------------|
|
|
194
|
-
| `--account_id` | `string` | no | | Account to search on behalf of. Defaults to the authenticated account. |
|
|
195
|
-
| `--platform` | `string` | yes | | The ad network whose targeting taxonomy to search. |
|
|
196
|
-
| `--query` | `string` | no | | The search term. Blank browses the fixed lists; interests, work employers, job titles, schools, majors, and locations return nothing without one. |
|
|
197
|
-
| `--types` | `array` | no | | Kinds of targeting options to search. Defaults to all of them. |
|
|
198
|
-
| `--location_types` | `array` | no | | Narrow location results to these kinds of places. Only applies when `types` includes `locations`. |
|
|
199
|
-
| `--country` | `string` | no | | Narrow location results to one country, as an ISO 3166-1 code such as `US`. Only applies when `types` includes `locations`. |
|
|
200
|
-
| `--limit` | `number` | no | `25` | Maximum number of results per requested type. |
|
|
201
|
-
|
|
202
|
-
---
|
|
203
|
-
|
|
204
|
-
# whop ad-groups unpause
|
|
205
|
-
|
|
206
|
-
Unpause an Ad Group
|
|
207
|
-
|
|
208
|
-
## Arguments
|
|
209
|
-
|
|
210
|
-
| Name | Type | Required | Description |
|
|
211
|
-
|------|------|----------|-------------|
|
|
212
|
-
| `id` | `string` | yes | The ad group ID. |
|
|
213
|
-
|
|
214
|
-
## Options
|
|
215
|
-
|
|
216
|
-
| Flag | Type | Required | Default | Description |
|
|
217
|
-
|------|------|----------|---------|-------------|
|
|
218
|
-
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
219
|
-
|
|
220
|
-
> Confirm with the user before executing this destructive command.
|
|
221
|
-
|
|
222
|
-
---
|
|
223
|
-
|
|
224
|
-
# whop ad-groups update
|
|
225
|
-
|
|
226
|
-
Update an Ad Group
|
|
227
|
-
|
|
228
|
-
## Arguments
|
|
229
|
-
|
|
230
|
-
| Name | Type | Required | Description |
|
|
231
|
-
|------|------|----------|-------------|
|
|
232
|
-
| `id` | `string` | yes | The ad group ID. |
|
|
233
|
-
|
|
234
|
-
## Options
|
|
235
|
-
|
|
236
|
-
| Flag | Type | Required | Default | Description |
|
|
237
|
-
|------|------|----------|---------|-------------|
|
|
238
|
-
| `--audiences` | `object` | no | | Saved audiences to deliver to or exclude. Can't be combined with demographics.automatic. |
|
|
239
|
-
| `--bid_type` | `string` | no | | How delivery bids are set in the ad auction. Target-based strategies use `desired_cost_per_result`. |
|
|
240
|
-
| `--budget_amount` | `number` | no | | This ad group's budget, in the ad account's currency. Omit when the budget is set on the campaign instead. |
|
|
241
|
-
| `--budget_type` | `string` | no | | Whether budget_amount is spent per day (`daily`) or over the ad group's full run (`lifetime`). |
|
|
242
|
-
| `--conversion_event` | `unknown` | no | | The pixel event optimized for. A standard event, or any custom pixel event name. |
|
|
243
|
-
| `--conversion_location` | `string` | no | | Where the outcome being optimized for occurs, such as a website visit, social-profile visit, messaging conversation, ad interaction, or lead-form submission. The lead form itself is set on the ad. |
|
|
244
|
-
| `--demographics` | `object` | no | | Age, gender, and automatic-audience targeting. |
|
|
245
|
-
| `--desired_cost_per_result` | `number` | no | | Cost per result to aim for (`average_target`) or never exceed (`maximum_target`). |
|
|
246
|
-
| `--detailed_targeting` | `object` | no | | Interest, behavior, and demographic targeting, using categories from the ad platform's targeting taxonomy. Entries across interests, behaviors, and demographics are OR'd together (anyone matching any entry is reached), matching Ads Manager's detailed-targeting box. At most 100 entries per section. Can't be combined with demographics.automatic, and unavailable to campaigns with special_ad_categories. |
|
|
247
|
-
| `--devices` | `object` | no | | Device platforms and operating systems to target. |
|
|
248
|
-
| `--ends_at` | `string` | no | | When the ad group stops delivering, as an ISO 8601 timestamp. Omit to run until paused. |
|
|
249
|
-
| `--frequency_cap` | `object` | no | | Cap on how often one person sees ads from this ad group. Only available on campaigns with the `awareness` objective. |
|
|
250
|
-
| `--languages` | `array` | no | | Languages to target, as ISO 639 codes such as `en` or `es`. Empty or omitted targets all languages. |
|
|
251
|
-
| `--message_apps` | `array` | no | | Apps the conversation opens in. Required when setting `conversion_location` to `messaging`, and rejected unless the ad group's conversion location is `messaging`. |
|
|
252
|
-
| `--minimum_daily_spend` | `number` | no | | Minimum the ad group tries to spend each day. |
|
|
253
|
-
| `--optimization_goal` | `string` | no | | The result the ad group's delivery is optimized to get the most of. |
|
|
254
|
-
| `--placements` | `unknown` | no | | `automatic` to let the ad platform choose placements, or the list of platforms and positions to target. Omit a platform's positions to target all of them.
|
|
255
|
-
|
|
256
|
-
Valid positions per platform:
|
|
257
|
-
|
|
258
|
-
- `facebook`: `feed`, `right_hand_column`, `marketplace`, `search`, `profile_feed`, `notification`, `story`, `instream_video`, `facebook_reels`, `facebook_reels_overlay`, `biz_disco_feed`
|
|
259
|
-
- `instagram`: `stream`, `story`, `explore`, `explore_home`, `reels`, `profile_feed`, `profile_reels`, `ig_search`
|
|
260
|
-
- `messenger`: `story`
|
|
261
|
-
- `audience_network`: `classic`, `rewarded_video`
|
|
262
|
-
- `threads`: `threads_stream`
|
|
263
|
-
- `whatsapp`: `status` |
|
|
264
|
-
| `--regions` | `object` | no | | Locations to target and exclude. |
|
|
265
|
-
| `--starts_at` | `string` | no | | When the ad group starts delivering, as an ISO 8601 timestamp. Omit to start as soon as it's active. |
|
|
266
|
-
| `--status` | `string` | no | | Initial status (default: `active`). |
|
|
267
|
-
| `--title` | `string` | no | | The display name of the ad group. |
|
|
268
|
-
|
|
269
|
-
> Confirm with the user before executing this destructive command.
|