v9

OpenAPI 3.1.02026-08-043703845.2 MB

Apps

Update App

Updates the settings, metadata, or status of an app. Fields that are omitted keep their current value.

patch/apps/{id}

Request body

app_store_descriptionstring

The detailed description shown on the app store's in-depth app view page.

app_type'b2b_app' | 'b2c_app' | 'company_app' | 'component'

The type of end-user the app is built for.

base_urlstring

The base production URL where the app is hosted.

dashboard_pathstring nullable

The URL path for the account dashboard view.

descriptionstring

A short description of the app shown in listings and search results.

discover_pathstring nullable

The URL path for the discover view.

experience_pathstring nullable

The URL path for the member-facing hub view, such as /experiences/[experienceId].

namestring

The display name for the app, shown to users on the app store and product pages.

oauth_client_type'public' | 'confidential'

How the app authenticates at the OAuth token endpoint.

openapi_pathstring nullable

The URL path to the app's OpenAPI spec file (requires the ai_chat capability).

production_android_build_idstring nullable

The app build (abld_ tag) to serve as the Android production build, or null to unassign it. Same rules as production_web_build_id.

production_ios_build_idstring nullable

The app build (abld_ tag) to serve as the iOS production build, or null to unassign it. Same rules as production_web_build_id.

production_web_build_idstring nullable

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.

redirect_urisstring[]

The whitelisted OAuth callback URLs users are redirected to after authorizing the app.

required_scopesstring[]

The OAuth scopes the app requests from users when they install it.

routestring

The subdomain route where the app's hosted web builds are served.

secretsobject

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.

skills_pathstring nullable

The URL path to the app's skills directory (requires the ai_chat capability).

status'live' | 'unlisted' | 'hidden'

Controls whether the app is published on Whop discovery or accessible only through its direct link. Publishing requires a name, icon, and description.

Response

app updated

app_store_descriptionstring nullable required

Detailed description shown on the app store's in-depth app page, or null when none has been set.

app_type'b2b_app' | 'b2c_app' | 'company_app' | 'component' required

The type of end-user the app is built for.

base_urlstring nullable required

Production base URL where the app is hosted, or null if none is configured.

dashboard_pathstring nullable required

URL path for the account dashboard view, or null when not configured.

descriptionstring nullable required

Short description shown in listings and search results, or null if none has been set.

discover_pathstring nullable required

URL path for the discover view, or null when not configured.

domain_idstring required

Subdomain identifier for the app's proxied URL, forming https://{domain_id}.apps.whop.com.

experience_pathstring nullable required

URL path for the member-facing hub view, or null when not configured.

hosted_urlstring nullable required

Full URL where the app's hosted web build is served, or null if no route is claimed.

idstring required

App ID, prefixed app_.

marketplace_status'not_available' | 'pending_review' | 'live_marketplace' | 'null' nullable required

Approval status of the app's product listing on the Whop app store, or null when the app has no associated product.

namestring required

Display name shown on the app store and in experience navigation.

oauth_client_type'public' | 'confidential' required

How the app authenticates at the OAuth token endpoint.

openapi_pathstring nullable required

URL path to the app's OpenAPI spec file, or null when not configured.

originstring nullable required

Full origin URL of the app's proxied domain, for example https://ab1c2d3e4f.apps.whop.com.

product_idstring nullable required

ID of the app's product listing on the Whop app store, or null when the app has no associated product.

redirect_urisstring[] required

required_scopesstring[] required

routestring nullable required

Claimed subdomain route where hosted web builds are served (myapp for myapp.whop.app), or null if no route is claimed.

secretsobject nullable required

The app's production secrets as an object of string values, injected into the hosted server runtime. null when the caller lacks the developer:update_app permission.

skills_pathstring nullable required

URL path to the app's skills directory, or null when not configured.

status'live' | 'unlisted' | 'hidden' required

Visibility on the Whop app store: live is publicly discoverable, unlisted is accessible only via direct link, hidden is not visible anywhere.

verifiedboolean required

Whether the app has been verified by Whop and is eligible for the featured apps section.

Example response

{
  "app_type": "b2b_app",
  "marketplace_status": "not_available",
  "oauth_client_type": "public",
  "production_android_build": {
    "status": "draft"
  },
  "production_ios_build": {
    "status": "draft"
  },
  "production_web_build": {
    "status": "draft"
  },
  "required_scopes": [
    "read_user"
  ],
  "status": "live"
}