@whop/cli 0.14.1 → 0.14.3

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.
Files changed (42) hide show
  1. package/README.md +3 -3
  2. package/dist/index.js +22283 -7154
  3. package/dist/index.js.map +1 -1
  4. package/package.json +1 -1
  5. package/skills/whop-accounts/SKILL.md +195 -15
  6. package/skills/whop-ad-campaigns/SKILL.md +193 -15
  7. package/skills/whop-ad-groups/SKILL.md +258 -16
  8. package/skills/whop-ads/SKILL.md +190 -14
  9. package/skills/whop-api-keys/SKILL.md +113 -13
  10. package/skills/whop-app-builds/SKILL.md +68 -8
  11. package/skills/whop-apps/SKILL.md +135 -12
  12. package/skills/whop-audiences/SKILL.md +92 -8
  13. package/skills/whop-bounties/SKILL.md +104 -9
  14. package/skills/whop-bounty-submissions/SKILL.md +82 -9
  15. package/skills/whop-cards/SKILL.md +122 -12
  16. package/skills/whop-checkout-configurations/SKILL.md +64 -8
  17. package/skills/whop-deposits/SKILL.md +13 -5
  18. package/skills/whop-disputes/SKILL.md +86 -9
  19. package/skills/whop-events/SKILL.md +90 -8
  20. package/skills/whop-exports/SKILL.md +331 -7
  21. package/skills/whop-ledgers/SKILL.md +38 -6
  22. package/skills/whop-media/SKILL.md +28 -7
  23. package/skills/whop-members/SKILL.md +51 -6
  24. package/skills/whop-memberships/SKILL.md +137 -13
  25. package/skills/whop-notifications/SKILL.md +91 -12
  26. package/skills/whop-partners/SKILL.md +102 -12
  27. package/skills/whop-payments/SKILL.md +40 -0
  28. package/skills/whop-payouts/SKILL.md +130 -9
  29. package/skills/whop-people/SKILL.md +50 -6
  30. package/skills/whop-permissions/SKILL.md +8 -5
  31. package/skills/whop-plans/SKILL.md +152 -12
  32. package/skills/whop-products/SKILL.md +141 -13
  33. package/skills/whop-resolution-center-cases/SKILL.md +222 -17
  34. package/skills/whop-setup-intents/SKILL.md +20 -0
  35. package/skills/whop-shipments/SKILL.md +66 -8
  36. package/skills/whop-social-accounts/SKILL.md +112 -11
  37. package/skills/whop-stats/SKILL.md +50 -6
  38. package/skills/whop-swaps/SKILL.md +63 -8
  39. package/skills/whop-team-members/SKILL.md +80 -9
  40. package/skills/whop-transfers/SKILL.md +67 -8
  41. package/skills/whop-users/SKILL.md +295 -18
  42. package/skills/whop-verifications/SKILL.md +51 -9
@@ -9,13 +9,73 @@ An App Build is a versioned artifact uploaded for an app — a hosted web archiv
9
9
 
10
10
  Use the App Builds API to upload a build for an app, list an app's builds with platform and status filters, retrieve a build, and promote a draft or approved build to production.
11
11
 
12
- ## Commands
12
+ # whop app-builds create
13
13
 
14
- | Command | Description |
15
- |---------|-------------|
16
- | `whop app-builds list` | List App Builds |
17
- | `whop app-builds create` | Create App Build |
18
- | `whop app-builds get` | Retrieve App Build |
19
- | `whop app-builds promote` | Promote App Build |
14
+ Create App Build
20
15
 
21
- Run `whop app-builds <command> --help` for options, or `whop app-builds <command> --schema` for full argument details.
16
+ ## Options
17
+
18
+ | Flag | Type | Required | Default | Description |
19
+ |------|------|----------|---------|-------------|
20
+ | `--ai_prompt_id` | `string` | no | | The AI prompt that generated this build, if applicable. |
21
+ | `--app_id` | `string` | no | | The app to create the build for, prefixed `app_`. Defaults to the app behind the presented credential. |
22
+ | `--attachment` | `object` | yes | | The uploaded build file: `{ id }` for an existing file or `{ direct_upload_id }` for a completed direct upload. |
23
+ | `--checksum` | `string` | yes | | A client-generated checksum of the build file, used to verify file integrity when unpacked. |
24
+ | `--platform` | `string` | yes | | The target platform for the build. |
25
+ | `--source_attachment` | `object` | no | | An optional compressed archive (.zip or .gz) of the source code that produced this build, stored alongside the build so it can be downloaded later. Referenced like `attachment`, and must be a different file. |
26
+ | `--supported_app_view_types` | `array` | no | | The view types this build supports. Only list the ones its code implements. |
27
+ | `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
28
+
29
+ > Confirm with the user before executing this destructive command.
30
+
31
+ ---
32
+
33
+ # whop app-builds get
34
+
35
+ Retrieve App Build
36
+
37
+ ## Arguments
38
+
39
+ | Name | Type | Required | Description |
40
+ |------|------|----------|-------------|
41
+ | `id` | `string` | yes | App build ID, prefixed `abld_`. |
42
+
43
+ ---
44
+
45
+ # whop app-builds list
46
+
47
+ List App Builds
48
+
49
+ ## Options
50
+
51
+ | Flag | Type | Required | Default | Description |
52
+ |------|------|----------|---------|-------------|
53
+ | `--app_id` | `string` | yes | | The app to list builds for, prefixed `app_`. |
54
+ | `--platform` | `string` | no | | Filter builds by target platform. |
55
+ | `--status` | `string` | no | | Filter builds by review status. |
56
+ | `--created_before` | `number` | no | | Only return builds created before this ISO 8601 timestamp. |
57
+ | `--created_after` | `number` | no | | Only return builds created after this ISO 8601 timestamp. |
58
+ | `--first` | `number` | no | | The number of builds to return (default 20, max 100). |
59
+ | `--after` | `string` | no | | A cursor; returns builds after this position. |
60
+ | `--last` | `number` | no | | The number of builds to return from the end of the range. |
61
+ | `--before` | `string` | no | | A cursor; returns builds before this position. |
62
+
63
+ ---
64
+
65
+ # whop app-builds promote
66
+
67
+ Promote App Build
68
+
69
+ ## Arguments
70
+
71
+ | Name | Type | Required | Description |
72
+ |------|------|----------|-------------|
73
+ | `id` | `string` | yes | App build ID, prefixed `abld_`. |
74
+
75
+ ## Options
76
+
77
+ | Flag | Type | Required | Default | Description |
78
+ |------|------|----------|---------|-------------|
79
+ | `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
80
+
81
+ > Confirm with the user before executing this destructive command.
@@ -9,15 +9,138 @@ An App is software you build on Whop. It can be a hosted web app served at `<rou
9
9
 
10
10
  Use the Apps API to manage app configuration and, for hosted apps, read server runtime logs for console output, uncaught exceptions, and failed requests. Logs are retained for 7 days and can be filtered by build, level, time window, and message text.
11
11
 
12
- ## Commands
13
-
14
- | Command | Description |
15
- |---------|-------------|
16
- | `whop apps list` | List Apps |
17
- | `whop apps create` | Create App |
18
- | `whop apps get` | Retrieve App |
19
- | `whop apps update` | Update App |
20
- | `whop apps logs` | List App Logs |
21
- | `whop apps permissions` | Update App Permissions |
22
-
23
- Run `whop apps <command> --help` for options, or `whop apps <command> --schema` for full argument details.
12
+ # whop apps create
13
+
14
+ Create App
15
+
16
+ ## Options
17
+
18
+ | Flag | Type | Required | Default | Description |
19
+ |------|------|----------|---------|-------------|
20
+ | `--account_id` | `string` | no | | The account to create the app for (`biz_` tag). Defaults to the account behind the presented credential. |
21
+ | `--base_url` | `unknown` | no | | The base production URL where the app is hosted, such as `https://myapp.example.com`. |
22
+ | `--icon` | `object` | no | | The icon image for the app in PNG, JPEG, or GIF format, referencing an uploaded file: `{ id }` for an existing attachment or `{ direct_upload_id }` for a new direct upload. |
23
+ | `--name` | `string` | yes | | The display name for the app, shown to users on the app store and product pages. |
24
+ | `--redirect_uris` | `array` | no | | The whitelisted OAuth callback URLs that users are redirected to after authorizing the app. |
25
+ | `--route` | `unknown` | no | | The subdomain route where the app's hosted web builds are served, such as `myapp` for myapp.whop.app. |
26
+ | `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
27
+
28
+ > Confirm with the user before executing this destructive command.
29
+
30
+ ---
31
+
32
+ # whop apps get
33
+
34
+ Retrieve App
35
+
36
+ ## Arguments
37
+
38
+ | Name | Type | Required | Description |
39
+ |------|------|----------|-------------|
40
+ | `id` | `string` | yes | App ID (prefixed `app_`), the app's claimed route, or its proxy domain id. |
41
+
42
+ ---
43
+
44
+ # whop apps list
45
+
46
+ List Apps
47
+
48
+ ## Options
49
+
50
+ | Flag | Type | Required | Default | Description |
51
+ |------|------|----------|---------|-------------|
52
+ | `--account_id` | `string` | no | | Only return apps created by this account (`biz_` tag). With developer access to the account this includes its unlisted and hidden apps. |
53
+ | `--app_type` | `string` | no | | Filter apps by the type of end-user they are built for. |
54
+ | `--view_type` | `string` | no | | Only return apps supporting this view type, such as `dashboard` or `hub`. |
55
+ | `--verified_apps_only` | `boolean` | no | | Whether to only return apps verified by Whop. |
56
+ | `--query` | `string` | no | | A search string matched against app names. |
57
+ | `--order` | `string` | no | | The field to sort apps by. Defaults to discoverable_at, showing the most recently published apps first. |
58
+ | `--direction` | `string` | no | | Sort direction. |
59
+ | `--first` | `number` | no | | The number of apps to return (default 20, max 100). |
60
+ | `--after` | `string` | no | | A cursor; returns apps after this position. |
61
+ | `--last` | `number` | no | | The number of apps to return from the end of the range. |
62
+ | `--before` | `string` | no | | A cursor; returns apps before this position. |
63
+
64
+ ---
65
+
66
+ # whop apps logs
67
+
68
+ List App Logs
69
+
70
+ ## Arguments
71
+
72
+ | Name | Type | Required | Description |
73
+ |------|------|----------|-------------|
74
+ | `id` | `string` | yes | The ID of the app, which will look like app_*************. |
75
+
76
+ ## Options
77
+
78
+ | Flag | Type | Required | Default | Description |
79
+ |------|------|----------|---------|-------------|
80
+ | `--app_build_id` | `string` | no | | Only return logs from this build. |
81
+ | `--level` | `string` | no | | Only return console lines of this level. |
82
+ | `--query` | `string` | no | | Only return logs whose message contains this text (case-insensitive). |
83
+ | `--created_after` | `string` | no | | Start of the time window as an ISO 8601 timestamp. Defaults to 7 days before created_before. |
84
+ | `--created_before` | `string` | no | | End of the time window as an ISO 8601 timestamp. Defaults to now. |
85
+ | `--first` | `number` | no | | The number of log lines to return (max 500). |
86
+ | `--after` | `string` | no | | A cursor for fetching logs after a previous page. |
87
+ | `--before` | `string` | no | | A cursor for fetching logs before a later page. |
88
+
89
+ ---
90
+
91
+ # whop apps permissions
92
+
93
+ Update App Permissions
94
+
95
+ ## Arguments
96
+
97
+ | Name | Type | Required | Description |
98
+ |------|------|----------|-------------|
99
+ | `id` | `string` | yes | App ID, prefixed `app_`. |
100
+
101
+ ## Options
102
+
103
+ | Flag | Type | Required | Default | Description |
104
+ |------|------|----------|---------|-------------|
105
+ | `--requested_permissions` | `array` | yes | | The full set of permissions the app requests on install; permissions not listed are removed. |
106
+
107
+ > Confirm with the user before executing this destructive command.
108
+
109
+ ---
110
+
111
+ # whop apps update
112
+
113
+ Update App
114
+
115
+ ## Arguments
116
+
117
+ | Name | Type | Required | Description |
118
+ |------|------|----------|-------------|
119
+ | `id` | `string` | yes | App ID (prefixed `app_`), the app's claimed route, or its proxy domain id. |
120
+
121
+ ## Options
122
+
123
+ | Flag | Type | Required | Default | Description |
124
+ |------|------|----------|---------|-------------|
125
+ | `--app_store_description` | `string` | no | | The detailed description shown on the app store's in-depth app view page. |
126
+ | `--app_type` | `string` | no | | The type of end-user the app is built for. |
127
+ | `--base_url` | `string` | no | | The base production URL where the app is hosted. |
128
+ | `--dashboard_path` | `unknown` | no | | The URL path for the account dashboard view. |
129
+ | `--description` | `string` | no | | A short description of the app shown in listings and search results. |
130
+ | `--discover_path` | `unknown` | no | | The URL path for the discover view. |
131
+ | `--experience_path` | `unknown` | no | | The URL path for the member-facing hub view, such as `/experiences/[experienceId]`. |
132
+ | `--icon` | `object` | no | | The icon image for the app in PNG, JPEG, or GIF format, referencing an uploaded file: `{ id }` for an existing attachment or `{ direct_upload_id }` for a new direct upload. |
133
+ | `--name` | `string` | no | | The display name for the app, shown to users on the app store and product pages. |
134
+ | `--oauth_client_type` | `string` | no | | How the app authenticates at the OAuth token endpoint. |
135
+ | `--openapi_path` | `unknown` | no | | The URL path to the app's OpenAPI spec file (requires the ai_chat capability). |
136
+ | `--production_android_build_id` | `unknown` | no | | The app build (`abld_` tag) to serve as the Android production build, or `null` to unassign it. Same rules as `production_web_build_id`. |
137
+ | `--production_ios_build_id` | `unknown` | no | | The app build (`abld_` tag) to serve as the iOS production build, or `null` to unassign it. Same rules as `production_web_build_id`. |
138
+ | `--production_web_build_id` | `unknown` | no | | The app build (`abld_` tag) to serve as the web production build, or `null` to unassign it. The build must belong to this app, target web, and be in the draft or approved status; a draft build is queued for approval and takes over once approved. Requires the `developer:manage_builds` scope. |
139
+ | `--redirect_uris` | `array` | no | | The whitelisted OAuth callback URLs users are redirected to after authorizing the app. |
140
+ | `--required_scopes` | `array` | no | | The OAuth scopes the app requests from users when they install it. |
141
+ | `--route` | `string` | no | | The subdomain route where the app's hosted web builds are served. |
142
+ | `--secrets` | `object` | no | | Secrets to add or overwrite on the app, as an object of string values. Keys not included are left untouched; pass null or an empty string as the value to delete a secret. Encrypted at rest and injected into the app's hosted server runtime. |
143
+ | `--skills_path` | `unknown` | no | | The URL path to the app's skills directory (requires the ai_chat capability). |
144
+ | `--status` | `string` | no | | Controls whether the app is published on Whop discovery or accessible only through its direct link. Publishing requires a name, icon, and description. |
145
+
146
+ > Confirm with the user before executing this destructive command.
@@ -9,13 +9,97 @@ An Audience represents a customer list uploaded to Whop for ad targeting. Audien
9
9
 
10
10
  Use the Audiences API to create audiences from CSV uploads, monitor processing status, and list or delete audiences for an account. Created audiences are usable for targeting after processing reaches `ready` or `partial`.
11
11
 
12
- ## Commands
12
+ # whop audiences add_people
13
13
 
14
- | Command | Description |
15
- |---------|-------------|
16
- | `whop audiences list` | List Audiences |
17
- | `whop audiences create` | Create Audience |
18
- | `whop audiences delete` | Delete Audience |
19
- | `whop audiences update` | Update Audience |
14
+ Add People
20
15
 
21
- Run `whop audiences <command> --help` for options, or `whop audiences <command> --schema` for full argument details.
16
+ ## Arguments
17
+
18
+ | Name | Type | Required | Description |
19
+ |------|------|----------|-------------|
20
+ | `audience_id` | `string` | yes | Audience ID, prefixed `adaud_`. |
21
+
22
+ ## Options
23
+
24
+ | Flag | Type | Required | Default | Description |
25
+ |------|------|----------|---------|-------------|
26
+ | `--file_id` | `string` | yes | | The new customer CSV — a file id (`file_...`) returned by `POST /files`. Its headers must match the audience's saved column mapping. |
27
+ | `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
28
+
29
+ > Confirm with the user before executing this destructive command.
30
+
31
+ ---
32
+
33
+ # whop audiences create
34
+
35
+ Create Audience
36
+
37
+ ## Options
38
+
39
+ | Flag | Type | Required | Default | Description |
40
+ |------|------|----------|---------|-------------|
41
+ | `--account_id` | `string` | yes | | Account ID, prefixed `biz_`. |
42
+ | `--audience_type` | `string` | no | | What to create. Defaults to `custom` (CSV upload). |
43
+ | `--auto_refresh` | `boolean` | no | | Filter audiences only, and set only at creation. `true` (the default) rebuilds membership from the filters twice a day. `false` keeps whoever matched at creation and never rebuilds. |
44
+ | `--column_mapping` | `object` | no | | Custom audiences only. Maps supported identity fields to CSV column headers. Map at least one of `email` or `phone`. |
45
+ | `--count` | `number` | no | | Lookalikes only. Number of lookalike audiences to create (1–6). |
46
+ | `--file_id` | `string` | no | | Custom audiences only. The uploaded customer CSV — a file id (`file_...`) returned by `POST /files`. |
47
+ | `--filters` | `object` | no | | Filter audiences only. The People filters that define membership, keyed exactly as `GET /people` accepts them — for example `{"os": "iOS", "country": "US"}`. Date filters must be rolling windows — `first_seen_within_days` or `last_seen_within_days` — so the audience re-anchors on every refresh; fixed dates such as `first_seen_after` are rejected. Source values are canonical source paths (`whop:<campaign>:<group>:<ad>`, `ext:<platform>:...`, `referrer:<domain>`, `direct`), exact or with a trailing `:*` wildcard. |
48
+ | `--name` | `string` | no | | Audience display name. Required for custom audiences; lookalike names are generated from the source audience. |
49
+ | `--percentage` | `number` | no | | Lookalikes only. Total similarity reach as a whole percent (1–20), sliced evenly across `count` — must be divisible by `count`. |
50
+ | `--source_audience_id` | `string` | no | | Lookalikes only. The ready custom audience (`adaud_`) to build from; it needs at least 100 matched people. |
51
+ | `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
52
+
53
+ > Confirm with the user before executing this destructive command.
54
+
55
+ ---
56
+
57
+ # whop audiences delete
58
+
59
+ Delete Audience
60
+
61
+ ## Arguments
62
+
63
+ | Name | Type | Required | Description |
64
+ |------|------|----------|-------------|
65
+ | `audience_id` | `string` | yes | Audience ID, prefixed `adaud_`. |
66
+
67
+ > Confirm with the user before executing this destructive command.
68
+
69
+ ---
70
+
71
+ # whop audiences list
72
+
73
+ List Audiences
74
+
75
+ ## Options
76
+
77
+ | Flag | Type | Required | Default | Description |
78
+ |------|------|----------|---------|-------------|
79
+ | `--account_id` | `string` | no | | Account ID, prefixed `biz_`. |
80
+ | `--audience_id` | `string` | no | | Audience ID, prefixed `adaud_`, used to filter the response to one audience. |
81
+ | `--audience_type` | `string` | no | | Filter by audience type: `custom` (uploaded lists) or `lookalike`. |
82
+ | `--source_type` | `string` | no | | Filter by member source: `csv_upload` (uploaded lists) or `people_filter` (automatic audiences built from saved People filters). |
83
+ | `--first` | `number` | no | | Number of audiences to return. Defaults to 20; maximum 100. |
84
+ | `--after` | `string` | no | | Cursor for the next page of audiences. |
85
+
86
+ ---
87
+
88
+ # whop audiences update
89
+
90
+ Update Audience
91
+
92
+ ## Arguments
93
+
94
+ | Name | Type | Required | Description |
95
+ |------|------|----------|-------------|
96
+ | `audience_id` | `string` | yes | Audience ID, prefixed `adaud_`. |
97
+
98
+ ## Options
99
+
100
+ | Flag | Type | Required | Default | Description |
101
+ |------|------|----------|---------|-------------|
102
+ | `--filters` | `object` | no | | Replaces the People filters that define membership. The whole definition is replaced rather than merged, so send every filter you want to keep — a filter you leave out stops applying. Keys and values are the ones `GET /people` accepts, such as an `os` of `iOS` or a `country` of `US`, and at least one filter is required. Date filters must be rolling windows — `first_seen_within_days` or `last_seen_within_days` — so the audience re-anchors every time it rebuilds; fixed dates such as `first_seen_after` are rejected, as is `audience_id`. An array value holds at most 500 items, and each value at most 10 KB. Only an audience with a `source_type` of `people_filter` and `auto_refresh` of `true` accepts filters: an uploaded list has no filters to replace, and with auto refresh off the audience keeps the people it matched when it was built, so create a new audience instead. |
103
+ | `--name` | `string` | no | | New audience display name. A blank value is ignored rather than clearing the name. |
104
+
105
+ > Confirm with the user before executing this destructive command.
@@ -9,14 +9,109 @@ A Bounty is a paid task posted by an account or user. The reward is held in escr
9
9
 
10
10
  Use the Bounties API to create and publish a bounty, list an account's bounties for reporting or dashboards, list the bounties a user can work or has participated in, and retrieve a single bounty by ID.
11
11
 
12
- ## Commands
12
+ # whop bounties cancel
13
13
 
14
- | Command | Description |
15
- |---------|-------------|
16
- | `whop bounties list` | List Bounties |
17
- | `whop bounties create` | Create Bounty |
18
- | `whop bounties get` | Retrieve Bounty |
19
- | `whop bounties update` | Update Bounty |
20
- | `whop bounties cancel` | Cancel |
14
+ Cancel
21
15
 
22
- Run `whop bounties <command> --help` for options, or `whop bounties <command> --schema` for full argument details.
16
+ ## Arguments
17
+
18
+ | Name | Type | Required | Description |
19
+ |------|------|----------|-------------|
20
+ | `id` | `string` | yes | Bounty ID (`bnty_` tag). |
21
+
22
+ ## Options
23
+
24
+ | Flag | Type | Required | Default | Description |
25
+ |------|------|----------|---------|-------------|
26
+ | `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
27
+
28
+ > Confirm with the user before executing this destructive command.
29
+
30
+ ---
31
+
32
+ # whop bounties create
33
+
34
+ Create Bounty
35
+
36
+ ## Options
37
+
38
+ | Flag | Type | Required | Default | Description |
39
+ |------|------|----------|---------|-------------|
40
+ | `--accepted_submissions_limit` | `number` | no | | Number of submissions that can be accepted (winner slots). Defaults to 1. The escrowed total is `gross_reward_amount` times this limit and must be at least $5. |
41
+ | `--account_id` | `unknown` | no | | Account whose balance funds the bounty pool (`biz_` tag). Defaults to the caller's personal balance. Requires permission to move the account's funds. |
42
+ | `--allowed_country_codes` | `unknown` | no | | Countries whose residents can work the bounty, as ISO 3166 alpha-2 codes. Empty means worldwide. |
43
+ | `--business_goal_type` | `string` | no | | What the poster wants the work to achieve, declared once here. |
44
+ | `--capture_spec` | `object` | no | | Per-bounty overrides of the served capture contract. Only accepted when `business_goal_type` is `data_capture`; omitted fields keep the platform defaults, and the resulting contract is echoed back as `capture_spec` on the bounty. |
45
+ | `--description` | `string` | yes | | Full task instructions shown to workers. |
46
+ | `--experience_id` | `unknown` | no | | Experience to host the bounty in (`exp_` tag). Any visibility — public for an open bounty, private for an invited one. Required unless account_id is set, in which case the bounty anchors in that account's public forum. |
47
+ | `--frequency` | `string` | no | | How often the schedule creates a new bounty. Each occurrence is a separate bounty. Defaults to `once`; only applies with `publish_at`. |
48
+ | `--gross_reward_amount` | `number` | yes | | Gross bounty-pool amount (USD) escrowed per accepted submission, in whole dollars. Platform fees and affiliate shares are paid from this amount. |
49
+ | `--publish_at` | `unknown` | no | | ISO 8601 time to publish the bounty. When set, the bounty is created as a hidden draft and funded + published at this time instead of immediately. |
50
+ | `--publish_at_timezone` | `unknown` | no | | IANA timezone for recurring occurrences. Required when publish_at is set. |
51
+ | `--title` | `string` | yes | | Short name of the task shown to workers. |
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 bounties get
59
+
60
+ Retrieve Bounty
61
+
62
+ ## Arguments
63
+
64
+ | Name | Type | Required | Description |
65
+ |------|------|----------|-------------|
66
+ | `id` | `string` | yes | Bounty ID (`bnty_` tag). |
67
+
68
+ ---
69
+
70
+ # whop bounties list
71
+
72
+ List Bounties
73
+
74
+ ## Options
75
+
76
+ | Flag | Type | Required | Default | Description |
77
+ |------|------|----------|---------|-------------|
78
+ | `--account_id` | `string` | no | | Scope the list to this account (`biz_` tag). Requires read access to the account; account API keys may pass their own account or a connected account. |
79
+ | `--user_id` | `string` | no | | List the bounties this user participated in (`user_` tag). Must be the authenticated user. |
80
+ | `--status` | `string` | no | | Filter by lifecycle state. |
81
+ | `--query` | `string` | no | | Substring match on the bounty title or ID. |
82
+ | `--created_after` | `string` | no | | Only bounties created after this ISO 8601 timestamp. |
83
+ | `--created_before` | `string` | no | | Only bounties created before this ISO 8601 timestamp. |
84
+ | `--order` | `string` | no | | Sort field. |
85
+ | `--direction` | `string` | no | | Sort direction. |
86
+ | `--first` | `number` | no | `20` | Number of bounties to return from the start of the window. |
87
+ | `--after` | `string` | no | | Cursor to paginate forwards from. |
88
+ | `--last` | `number` | no | | Number of bounties to return from the end of the window. |
89
+ | `--before` | `string` | no | | Cursor to paginate backwards from. |
90
+
91
+ ---
92
+
93
+ # whop bounties update
94
+
95
+ Update Bounty
96
+
97
+ ## Arguments
98
+
99
+ | Name | Type | Required | Description |
100
+ |------|------|----------|-------------|
101
+ | `id` | `string` | yes | Bounty ID (`bnty_` tag). |
102
+
103
+ ## Options
104
+
105
+ | Flag | Type | Required | Default | Description |
106
+ |------|------|----------|---------|-------------|
107
+ | `--accepted_submissions_limit` | `number` | no | | Scheduled drafts only. Number of submissions that can be accepted (winner slots). |
108
+ | `--allowed_country_codes` | `unknown` | no | | Replace the countries whose residents can work the bounty, as ISO 3166 alpha-2 codes. Empty means worldwide. |
109
+ | `--business_goal_type` | `string` | no | | What the poster wants the work to achieve, declared once here. |
110
+ | `--description` | `string` | no | | New full task instructions. |
111
+ | `--frequency` | `string` | no | | Scheduled drafts only. How often the schedule creates a new bounty. |
112
+ | `--gross_reward_amount` | `number` | no | | Scheduled drafts only. Gross bounty-pool amount (USD) escrowed per accepted submission. The escrowed total (this times accepted_submissions_limit) must stay at least $5. |
113
+ | `--publish_at` | `unknown` | no | | Scheduled drafts only. New ISO 8601 time to publish the draft. Must be in the future. |
114
+ | `--publish_at_timezone` | `unknown` | no | | Scheduled drafts only. IANA timezone for recurring occurrences. |
115
+ | `--title` | `string` | no | | New short name of the task. |
116
+
117
+ > Confirm with the user before executing this destructive command.
@@ -9,14 +9,87 @@ A Bounty Submission is one worker's attempt on a bounty. It starts as an in-prog
9
9
 
10
10
  Use the Bounty Submissions API to submit proof of completed work to a bounty, list the submissions you authored, and review the submissions on your bounties — across every bounty or narrowed to one.
11
11
 
12
- ## Commands
12
+ # whop bounty-submissions create
13
13
 
14
- | Command | Description |
15
- |---------|-------------|
16
- | `whop bounty-submissions list` | List Bounty Submissions |
17
- | `whop bounty-submissions create` | Create Bounty Submission |
18
- | `whop bounty-submissions delete` | Cancel Bounty Submission |
19
- | `whop bounty-submissions get` | Retrieve Bounty Submission |
20
- | `whop bounty-submissions submit` | Submit Bounty Submission |
14
+ Create Bounty Submission
21
15
 
22
- Run `whop bounty-submissions <command> --help` for options, or `whop bounty-submissions <command> --schema` for full argument details.
16
+ ## Options
17
+
18
+ | Flag | Type | Required | Default | Description |
19
+ |------|------|----------|---------|-------------|
20
+ | `--affiliate_code` | `unknown` | no | | Affiliate code crediting the referrer, when the worker arrived through one. |
21
+ | `--bounty_id` | `string` | yes | | The bounty to submit to (`bnty_` tag). |
22
+ | `--deliverable` | `unknown` | no | | The submitted work. Combine `urls`, `file_ids`, and `caption` freely; at least one link or file is required. |
23
+ | `--metadata` | `unknown` | no | | Optional capture metadata describing where and how the footage was recorded. Persisted on the submission. On a `data_capture` bounty every field except `fov` is required whenever metadata is provided. |
24
+ | `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
25
+
26
+ > Confirm with the user before executing this destructive command.
27
+
28
+ ---
29
+
30
+ # whop bounty-submissions delete
31
+
32
+ Cancel Bounty Submission
33
+
34
+ ## Arguments
35
+
36
+ | Name | Type | Required | Description |
37
+ |------|------|----------|-------------|
38
+ | `bounty_submission_id` | `string` | yes | The bounty submission to act on (`btys_` tag). |
39
+
40
+ > Confirm with the user before executing this destructive command.
41
+
42
+ ---
43
+
44
+ # whop bounty-submissions get
45
+
46
+ Retrieve Bounty Submission
47
+
48
+ ## Arguments
49
+
50
+ | Name | Type | Required | Description |
51
+ |------|------|----------|-------------|
52
+ | `bounty_submission_id` | `string` | yes | The bounty submission to act on (`btys_` tag). |
53
+
54
+ ---
55
+
56
+ # whop bounty-submissions list
57
+
58
+ List Bounty Submissions
59
+
60
+ ## Options
61
+
62
+ | Flag | Type | Required | Default | Description |
63
+ |------|------|----------|---------|-------------|
64
+ | `--account_id` | `string` | no | | Scope the list to submissions on this account's bounties (`biz_` tag). Requires read access to the account. |
65
+ | `--bounty_id` | `string` | no | | Only submissions on this bounty (`bnty_` tag). |
66
+ | `--status` | `string` | no | | Filter by lifecycle state. |
67
+ | `--created_after` | `string` | no | | Only submissions created after this ISO 8601 timestamp. |
68
+ | `--created_before` | `string` | no | | Only submissions created before this ISO 8601 timestamp. |
69
+ | `--order` | `string` | no | | Sort field. |
70
+ | `--direction` | `string` | no | | Sort direction. |
71
+ | `--first` | `number` | no | `20` | Number of submissions to return from the start of the window. |
72
+ | `--after` | `string` | no | | Cursor to paginate forwards from. |
73
+ | `--last` | `number` | no | | Number of submissions to return from the end of the window. |
74
+ | `--before` | `string` | no | | Cursor to paginate backwards from. |
75
+
76
+ ---
77
+
78
+ # whop bounty-submissions submit
79
+
80
+ Submit Bounty Submission
81
+
82
+ ## Arguments
83
+
84
+ | Name | Type | Required | Description |
85
+ |------|------|----------|-------------|
86
+ | `bounty_submission_id` | `string` | yes | The claimed attempt to submit for review (`btys_` tag). |
87
+
88
+ ## Options
89
+
90
+ | Flag | Type | Required | Default | Description |
91
+ |------|------|----------|---------|-------------|
92
+ | `--deliverable` | `unknown` | no | | Work to attach to the submission. Combine `urls`, `file_ids`, and `caption` freely; all are optional. |
93
+ | `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
94
+
95
+ > Confirm with the user before executing this destructive command.