@whop/cli 0.16.0 → 0.16.1

package/skills/whop-ad-groups/SKILL.md

@@ -1,269 +0,0 @@
----
-name: whop-ad-groups
-description: Audience, placements, and schedule within a campaign. Run `whop ad-groups --help` for usage details.
-requires_bin: whop
-command: whop ad-groups
----
-
-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.
-
-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.
-
-# whop ad-groups create
-
-Create an Ad Group
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--ad_campaign_id` | `string` | yes |  | The ad campaign to create the ad group in, prefixed `adcamp_`. |
-| `--audiences` | `object` | no |  | Saved audiences to deliver to or exclude. Can't be combined with demographics.automatic. |
-| `--bid_type` | `string` | no |  | How delivery bids are set in the ad auction. Target-based strategies use `desired_cost_per_result`. |
-| `--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. |
-| `--budget_type` | `string` | no |  | Whether budget_amount is spent per day (`daily`) or over the ad group's full run (`lifetime`). |
-| `--conversion_event` | `unknown` | no |  | The pixel event optimized for. A standard event, or any custom pixel event name. |
-| `--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. |
-| `--demographics` | `object` | no |  | Age, gender, and automatic-audience targeting. |
-| `--desired_cost_per_result` | `number` | no |  | Cost per result to aim for (`average_target`) or never exceed (`maximum_target`). |
-| `--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. |
-| `--devices` | `object` | no |  | Device platforms and operating systems to target. |
-| `--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. |
-| `--ends_at` | `string` | no |  | When the ad group stops delivering, as an ISO 8601 timestamp. Omit to run until paused. |
-| `--frequency_cap` | `object` | no |  | Cap on how often one person sees ads from this ad group. Only available on campaigns with the `awareness` objective. |
-| `--languages` | `array` | no |  | Languages to target, as ISO 639 codes such as `en` or `es`. Empty or omitted targets all languages. |
-| `--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`. |
-| `--minimum_daily_spend` | `number` | no |  | Minimum the ad group tries to spend each day. |
-| `--optimization_goal` | `string` | no |  | The result the ad group's delivery is optimized to get the most of. |
-| `--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.
-
-Valid positions per platform:
-
-- `facebook`: `feed`, `right_hand_column`, `marketplace`, `search`, `profile_feed`, `notification`, `story`, `instream_video`, `facebook_reels`, `facebook_reels_overlay`, `biz_disco_feed`
-- `instagram`: `stream`, `story`, `explore`, `explore_home`, `reels`, `profile_feed`, `profile_reels`, `ig_search`
-- `messenger`: `story`
-- `audience_network`: `classic`, `rewarded_video`
-- `threads`: `threads_stream`
-- `whatsapp`: `status` |
-| `--regions` | `object` | no |  | Locations to target and exclude. |
-| `--starts_at` | `string` | no |  | When the ad group starts delivering, as an ISO 8601 timestamp. Omit to start as soon as it's active. |
-| `--status` | `string` | no |  | Initial status (default: `active`). |
-| `--title` | `string` | no |  | The display name of the ad group. |
-| `--idempotency-key` | `string` | no |  | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
-
-> Confirm with the user before executing this destructive command.
-
----
-
-# whop ad-groups delete
-
-Delete an Ad Group
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | The ad group ID. |
-
-> Confirm with the user before executing this destructive command.
-
----
-
-# whop ad-groups duplicate
-
-Duplicate an Ad Group
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | The ad group ID. |
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--count` | `number` | no |  | Number of copies to create (1-10). Defaults to 1. |
-| `--preserve_engagement` | `boolean` | no |  | Whether the copied ads keep the original posts' engagement (likes, comments, shares). Defaults to false. |
-| `--target_ad_campaign_id` | `string` | no |  | Campaign to duplicate into. Defaults to the ad group's own campaign. |
-| `--idempotency-key` | `string` | no |  | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
-
-> Confirm with the user before executing this destructive command.
-
----
-
-# whop ad-groups estimate_reach
-
-Estimate Ad Group Reach
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--account_id` | `string` | no |  | Account to estimate on behalf of. Defaults to the authenticated account. |
-| `--audiences` | `object` | no |  | Saved audiences to deliver to or exclude. Can't be combined with demographics.automatic. |
-| `--demographics` | `object` | no |  | Age, gender, and automatic-audience targeting. |
-| `--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. |
-| `--devices` | `object` | no |  | Device platforms and operating systems to target. |
-| `--languages` | `array` | no |  | Languages to target, as ISO 639 codes such as `en` or `es`. Empty or omitted targets all languages. |
-| `--platform` | `string` | yes |  | The ad network the estimate runs on. |
-| `--regions` | `object` | no |  | Locations to target and exclude. |
-| `--idempotency-key` | `string` | no |  | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
-
-> Confirm with the user before executing this destructive command.
-
----
-
-# whop ad-groups get
-
-Retrieve an Ad Group
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | The ad group ID. |
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--stats_from` | `string` | no |  | Start of the stats window. |
-| `--stats_to` | `string` | no |  | End of the stats window. |
-| `--time_zone` | `string` | no |  | IANA timezone the stats window is interpreted in. Defaults to UTC. |
-| `--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. |
-
----
-
-# whop ad-groups list
-
-List Ad Groups
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--account_id` | `string` | no |  | Account whose ad groups to list. Defaults to the authenticated account. |
-| `--ad_campaign_id` | `string` | no |  | Filter to ad groups in this campaign. |
-| `--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). |
-| `--status` | `string` | no |  | Filter to ad groups with this status. |
-| `--query` | `string` | no |  | Filter ad groups by a title or ID substring. |
-| `--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. |
-| `--direction` | `string` | no |  | The sort direction. Defaults to desc. |
-| `--created_before` | `string` | no |  | Only return ad groups created before this timestamp. |
-| `--created_after` | `string` | no |  | Only return ad groups created after this timestamp. |
-| `--stats_from` | `string` | no |  | Start of the stats window. Defaults to all-time. |
-| `--stats_to` | `string` | no |  | End of the stats window. Defaults to now. |
-| `--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. |
-| `--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. |
-| `--first` | `number` | no | `20` | The number of ad groups to return. |
-| `--after` | `string` | no |  | Cursor to fetch the page after (from page_info.end_cursor). |
-| `--last` | `number` | no |  | The number of ad groups to return from the end of the range. |
-| `--before` | `string` | no |  | Cursor to fetch the page before (from page_info.start_cursor). |
-
----
-
-# whop ad-groups pause
-
-Pause an Ad Group
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | The ad group ID. |
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--idempotency-key` | `string` | no |  | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
-
-> Confirm with the user before executing this destructive command.
-
----
-
-# whop ad-groups targeting_options
-
-Search Targeting Options
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--account_id` | `string` | no |  | Account to search on behalf of. Defaults to the authenticated account. |
-| `--platform` | `string` | yes |  | The ad network whose targeting taxonomy to search. |
-| `--query` | `string` | no |  | The search term. Blank browses the fixed lists; interests, work employers, job titles, schools, majors, and locations return nothing without one. |
-| `--types` | `array` | no |  | Kinds of targeting options to search. Defaults to all of them. |
-| `--location_types` | `array` | no |  | Narrow location results to these kinds of places. Only applies when `types` includes `locations`. |
-| `--country` | `string` | no |  | Narrow location results to one country, as an ISO 3166-1 code such as `US`. Only applies when `types` includes `locations`. |
-| `--limit` | `number` | no | `25` | Maximum number of results per requested type. |
-
----
-
-# whop ad-groups unpause
-
-Unpause an Ad Group
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | The ad group ID. |
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--idempotency-key` | `string` | no |  | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
-
-> Confirm with the user before executing this destructive command.
-
----
-
-# whop ad-groups update
-
-Update an Ad Group
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | The ad group ID. |
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--audiences` | `object` | no |  | Saved audiences to deliver to or exclude. Can't be combined with demographics.automatic. |
-| `--bid_type` | `string` | no |  | How delivery bids are set in the ad auction. Target-based strategies use `desired_cost_per_result`. |
-| `--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. |
-| `--budget_type` | `string` | no |  | Whether budget_amount is spent per day (`daily`) or over the ad group's full run (`lifetime`). |
-| `--conversion_event` | `unknown` | no |  | The pixel event optimized for. A standard event, or any custom pixel event name. |
-| `--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. |
-| `--demographics` | `object` | no |  | Age, gender, and automatic-audience targeting. |
-| `--desired_cost_per_result` | `number` | no |  | Cost per result to aim for (`average_target`) or never exceed (`maximum_target`). |
-| `--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. |
-| `--devices` | `object` | no |  | Device platforms and operating systems to target. |
-| `--ends_at` | `string` | no |  | When the ad group stops delivering, as an ISO 8601 timestamp. Omit to run until paused. |
-| `--frequency_cap` | `object` | no |  | Cap on how often one person sees ads from this ad group. Only available on campaigns with the `awareness` objective. |
-| `--languages` | `array` | no |  | Languages to target, as ISO 639 codes such as `en` or `es`. Empty or omitted targets all languages. |
-| `--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`. |
-| `--minimum_daily_spend` | `number` | no |  | Minimum the ad group tries to spend each day. |
-| `--optimization_goal` | `string` | no |  | The result the ad group's delivery is optimized to get the most of. |
-| `--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.
-
-Valid positions per platform:
-
-- `facebook`: `feed`, `right_hand_column`, `marketplace`, `search`, `profile_feed`, `notification`, `story`, `instream_video`, `facebook_reels`, `facebook_reels_overlay`, `biz_disco_feed`
-- `instagram`: `stream`, `story`, `explore`, `explore_home`, `reels`, `profile_feed`, `profile_reels`, `ig_search`
-- `messenger`: `story`
-- `audience_network`: `classic`, `rewarded_video`
-- `threads`: `threads_stream`
-- `whatsapp`: `status` |
-| `--regions` | `object` | no |  | Locations to target and exclude. |
-| `--starts_at` | `string` | no |  | When the ad group starts delivering, as an ISO 8601 timestamp. Omit to start as soon as it's active. |
-| `--status` | `string` | no |  | Initial status (default: `active`). |
-| `--title` | `string` | no |  | The display name of the ad group. |
-
-> Confirm with the user before executing this destructive command.

package/skills/whop-ads/SKILL.md

@@ -1,277 +0,0 @@
----
-name: whop-ads
-description: "The creative: copy, assets, and destination URL. Run `whop ads --help` for usage details."
-requires_bin: whop
-command: whop ads
----
-
-An Ad is the individual creative unit delivered by an [ad group](https://docs.whop.com/api-reference/beta/ad-groups/ad-group). It holds the copy, creative assets, and destination URL for one ad.
-
-Use the Ads API to list ads for an account, create ads inside ad groups, retrieve or update creative details, delete ads that should stop running, and pause or resume delivery.
-
-# whop ads create
-
-Create an Ad
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--ad_group` | `object` | no |  | An inline ad group to create (same shape as POST /ad_groups, including ad_campaign_id). Creates the ad group and the ad together. Provide this OR ad_group_id. |
-| `--ad_group_id` | `string` | no |  | The existing ad group to create the ad in. Provide this OR ad_group, not both. |
-| `--call_to_action` | `string` | no |  | The call-to-action button shown on the ad. |
-| `--creatives` | `array` | no |  | The ad's creative assets. Each entry is an uploaded file id with an optional format; omit format for the original asset. Two or more entries with no format become a carousel (2-10 attachments), in order, sharing the ad's copy. |
-| `--descriptions` | `array` | no |  | The description variants shown on the ad. |
-| `--headlines` | `array` | no |  | The headline variants shown on the ad. |
-| `--lead_form` | `object` | no |  | Instant lead form for the ad. Only allowed when the ad group's conversion_location is an instant-form destination (instant_forms, instant_forms_and_messenger, website_and_instant_forms). Mutually exclusive with lead_form_id. |
-| `--lead_form_id` | `string` | no |  | Use an existing instant form instead of creating one — the form's platform ID, from a form already on the ad's Facebook page. Only allowed when the ad group's conversion_location is an instant-form destination. Mutually exclusive with lead_form. |
-| `--messaging_config` | `object` | no |  | Click-to-message welcome copy: the greeting (message) and the ice-breaker prompt (keyword). |
-| `--multi_advertiser_ads` | `boolean` | no |  | Whether the ad can appear alongside other advertisers' ads in the same unit. Defaults to true. |
-| `--post_id` | `string` | no |  | Promote an existing post instead of uploading creatives — a Facebook post or Instagram media id. Mutually exclusive with creatives. Pair with post_source. |
-| `--post_source` | `string` | no |  | Identifies the network that owns `post_id`. The source is inferred from the ID shape when omitted. |
-| `--primary_texts` | `array` | no |  | The primary text variants shown in the ad body. |
-| `--social_accounts` | `array` | no |  | The social accounts the ad runs under — a connected Facebook page and, optionally, an Instagram profile. |
-| `--title` | `string` | no |  | The display name of the ad. |
-| `--url` | `string` | no |  | The URL the ad links to. |
-| `--url_parameters` | `object` | no |  | Query parameters appended to the destination URL, keyed by parameter name. |
-| `--idempotency-key` | `string` | no |  | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
-
-> Confirm with the user before executing this destructive command.
-
----
-
-# whop ads delete
-
-Delete an Ad
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | The ad ID. |
-
-> Confirm with the user before executing this destructive command.
-
----
-
-# whop ads duplicate
-
-Duplicate an Ad
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | The ad ID. |
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--count` | `number` | no |  | Number of copies to create (1-10). Defaults to 1. |
-| `--preserve_engagement` | `boolean` | no |  | Whether the copies keep the original post's engagement (likes, comments, shares). Defaults to false. |
-| `--target_ad_group_id` | `string` | no |  | Ad group to duplicate into. Defaults to the ad's own ad group. |
-| `--idempotency-key` | `string` | no |  | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
-
-> Confirm with the user before executing this destructive command.
-
----
-
-# whop ads get
-
-Retrieve an Ad
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | The ad ID. |
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--stats_from` | `string` | no |  | Start of the stats window. |
-| `--stats_to` | `string` | no |  | End of the stats window. |
-| `--time_zone` | `string` | no |  | IANA timezone the stats window is interpreted in. Defaults to UTC. |
-| `--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. |
-
----
-
-# whop ads list
-
-List Ads
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--account_id` | `string` | no |  | The account the ads belong to. Defaults to the account-scoped key's own account. |
-| `--ad_campaign_id` | `string` | no |  | Only return ads in this ad campaign. |
-| `--ad_campaign_ids` | `array` | no |  | Only return ads in these ad campaigns (max 100). Repeat the parameter for each id (ad_campaign_ids=a&ad_campaign_ids=b). |
-| `--ad_group_id` | `string` | no |  | Only return ads in this ad group. |
-| `--ad_group_ids` | `array` | no |  | Only return ads in these ad groups (max 100). Repeat the parameter for each id (ad_group_ids=a&ad_group_ids=b). |
-| `--status` | `string` | no |  | Only return ads with this status. |
-| `--query` | `string` | no |  | Filter ads by a title or ID substring. |
-| `--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. |
-| `--direction` | `string` | no |  | The sort direction. Defaults to desc. |
-| `--created_before` | `string` | no |  | Only return ads created before this timestamp. |
-| `--created_after` | `string` | no |  | Only return ads created after this timestamp. |
-| `--stats_from` | `string` | no |  | Start of the stats window. Defaults to all-time. |
-| `--stats_to` | `string` | no |  | End of the stats window. Defaults to now. |
-| `--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. |
-| `--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. |
-| `--first` | `number` | no | `20` | The number of ads to return. |
-| `--after` | `string` | no |  | Cursor to fetch the page after (from page_info.end_cursor). |
-| `--last` | `number` | no |  | The number of ads to return from the end of the range. |
-| `--before` | `string` | no |  | Cursor to fetch the page before (from page_info.start_cursor). |
-
----
-
-# whop ads pause
-
-Pause an Ad
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | The ad ID. |
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--idempotency-key` | `string` | no |  | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
-
-> Confirm with the user before executing this destructive command.
-
----
-
-# whop ads unpause
-
-Unpause an Ad
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | The ad ID. |
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--idempotency-key` | `string` | no |  | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
-
-> Confirm with the user before executing this destructive command.
-
----
-
-# whop ads update
-
-Update an Ad
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | The ad ID. |
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--call_to_action` | `string` | no |  | The call-to-action button shown on the ad. |
-| `--creatives` | `array` | no |  | The ad's creative assets. Each entry is an uploaded file id with an optional format; omit format for the original asset. Replaces a live ad's creative on the platform. Two or more entries with no format replace it with a carousel (2-10 attachments), in order, sharing the ad's copy. |
-| `--descriptions` | `array` | no |  | The description variants shown on the ad. |
-| `--headlines` | `array` | no |  | The headline variants shown on the ad. |
-| `--lead_form` | `object` | no |  | Instant lead form for the ad. Only allowed when the ad group's conversion_location is an instant-form destination (instant_forms, instant_forms_and_messenger, website_and_instant_forms). Mutually exclusive with lead_form_id. |
-| `--lead_form_id` | `string` | no |  | Use an existing instant form instead of creating one — the form's platform ID, from a form already on the ad's Facebook page. Only allowed when the ad group's conversion_location is an instant-form destination. Mutually exclusive with lead_form. Replaces a stored lead_form. |
-| `--messaging_config` | `object` | no |  | Click-to-message welcome copy: the greeting (message) and the ice-breaker prompt (keyword). |
-| `--multi_advertiser_ads` | `boolean` | no |  | Whether the ad can appear alongside other advertisers' ads in the same unit. Defaults to true. |
-| `--post_id` | `string` | no |  | Promote an existing post instead of uploading creatives — a Facebook post or Instagram media id. Mutually exclusive with creatives. Pair with post_source. |
-| `--post_source` | `string` | no |  | Identifies the network that owns `post_id`. The source is inferred from the ID shape when omitted. |
-| `--primary_texts` | `array` | no |  | The primary text variants shown in the ad body. |
-| `--social_accounts` | `array` | no |  | The social accounts the ad runs under — a connected Facebook page and, optionally, an Instagram profile. |
-| `--title` | `string` | no |  | The display name of the ad. |
-| `--url` | `string` | no |  | The URL the ad links to. |
-| `--url_parameters` | `object` | no |  | Query parameters appended to the destination URL, keyed by parameter name. |
-
-> Confirm with the user before executing this destructive command.
-
-## Launch playbook — from nothing to a live ad
-
-Three commands take you from nothing to a launchable ad: generate a creative, create the campaign + ad group + ad in one request, then flip the campaign to active. Structured flags (`--ad_group`, `--creatives`, `--ads_payment_methods`) take JSON strings.
-
-### One-time setup
-
-1. **Auth** — `whop login` (OAuth). First-time billing setup requires a user login; an API key can only reorder already-configured payment methods. If a command fails with a scope error saying your login predates the scope, run `whop login` again.
-2. **Facebook page** — `whop social-accounts list` must show a `"platform": "facebook"` entry. Three ways to get one:
-   - **Already connected** — use its `sacc_` id as-is.
-   - **Link a Meta Business account** — `whop social-accounts connect --platform meta_business --scopes '["advertise"]' --redirect_url <url>`, then send the user to the returned `authorize_url`.
-   - **No page at all** — have Whop create one for the account: `whop social-accounts create --platform facebook`.
-3. **Ads payment method** — check with `whop accounts preferences --account_id <account_id>` (your `biz_` ID, from `whop accounts me`). If `ads_payment_methods` is null, configure balance billing:
-
-   ```sh
-   whop accounts update-preferences --account_id <account_id> --ads_payment_methods '{"primary": {"type": "platform_balance"}}'
-   ```
-
-   Only launching needs this — drafts work without. Fund the balance with `whop deposits create --amount 50` (returns a hosted deposit page URL).
-
-### 1. Generate a creative
-
-```sh
-whop media generate --type image --prompt "A running club jogging across a bridge at sunrise, warm light" --wait
-```
-
-`--wait` blocks until the asset is terminal and returns `file.id` — use that as the creative. Billed from the balance (`amount_charged`); a failed generation auto-refunds, so adjust the prompt and retry. Video: `--type video` plus optional `--duration_seconds` (5/10/15), `--resolution` (480p–4k), and up to 4 `--reference_media` file IDs (first one seeds the opening frame).
-
-### 2. Create the whole tree as a draft — one request
-
-```sh
-whop ads create \
-  --title "Run club launch ad" \
-  --primary_texts "Join 10,000 runners chasing their next PR together." \
-  --headlines "Find your stride" \
-  --call_to_action sign_up \
-  --url "https://whop.com/your-store-page" \
-  --creatives '[{"id": "file_XXXXXXXX"}]' \
-  --social_accounts '[{"id": "sacc_XXXXXXXX"}]' \
-  --ad_group '{
-    "title": "US broad",
-    "conversion_location": "website",
-    "regions": {"include": {"countries": ["US"]}},
-    "ad_campaign": {"title": "Run club growth", "platform": "meta", "objective": "sales", "status": "draft", "budget_amount": 25, "budget_optimization": "ad_campaign"}
-  }'
-```
-
-Field rules:
-
-| Field | Rule |
-|-------|------|
-| `creatives` | One entry with no `format` is required (the base asset). `square`/`vertical`/`horizontal` are optional crops on top. |
-| `url` | Required for website ads. A whop.com store page works as-is; an external page needs the Whop pixel installed. |
-| Budget | Default to CBO: `budget_amount` on the campaign with `budget_optimization: "ad_campaign"` (the network shifts spend to the best ad group). Per-ad-group `budget_amount` (ABO) is the manual alternative. One level owns it — never both. |
-| Targeting | Omit `demographics`/`placements`/`devices` for automatic optimization. `regions` uses ISO 3166 (`"US"`, `"US-CA"`). |
-| `lead_form` | Only with an instant-form `conversion_location`. |
-
-Reuse existing containers by passing `--ad_group_id adgrp_x` instead of `--ad_group`, or `"ad_campaign_id": "adcamp_x"` inside `--ad_group` instead of the inline `ad_campaign`.
-
-### 3. Launch
-
-`"status": "draft"` above kept money out of it. Review, then launch — this is when spend starts and the payment method is enforced:
-
-```sh
-whop ad-campaigns update adcamp_XXXXXXXX --status active
-```
-
-(Ready to spend immediately? Omit `"status": "draft"` and the one-shot create launches directly.)
-
-### 4. Monitor
-
-```sh
-whop ads get ad_XXXXXXXX
-```
-
-`delivery_status` is the live state (a brief `in_review` for moderation is normal); `issues[]` carries a human-readable `message` for anything the network rejected asynchronously. Control delivery with `pause`/`unpause` on ads, ad groups, or campaigns. Edit copy or creatives with `whop ads update` — sending `creatives` replaces the whole set, so include the base entry.