Skip to main content
PATCH
/
apps
/
{id}
JavaScript
import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const app = await client.apps.update('app_xxxxxxxxxxxxxx');

console.log(app.id);
{
  "id": "app_xxxxxxxxxxxxxx",
  "name": "Courses",
  "description": "A comprehensive analytics dashboard for tracking revenue, members, and growth metrics.",
  "status": "live",
  "base_url": "https://myapp.example.com",
  "domain_id": "ab1c2d3e4f5g6h7i8j9k",
  "verified": true,
  "app_type": "b2b_app",
  "experience_path": "/experiences/[experienceId]",
  "discover_path": "/experiences/[experienceId]",
  "dashboard_path": "/experiences/[experienceId]",
  "company": {
    "id": "biz_xxxxxxxxxxxxxx",
    "title": "Pickaxe"
  },
  "icon": {
    "url": "https://media.whop.com/abc123/optimized.jpg"
  },
  "creator": {
    "id": "user_xxxxxxxxxxxxx",
    "name": "John Doe",
    "username": "johndoe42"
  },
  "requested_permissions": [
    {
      "permission_action": {
        "action": "<string>",
        "name": "<string>"
      },
      "is_required": true,
      "justification": "<string>"
    }
  ],
  "stats": {
    "dau": 42,
    "mau": 42,
    "time_spent_last24_hours": 42,
    "wau": 42
  },
  "api_key": {
    "id": "<string>",
    "token": "<string>",
    "created_at": "2023-12-01T05:00:00.401Z"
  },
  "redirect_uris": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Path Parameters

​
id
string
required

The unique identifier of the app to update, starting with 'app_'.

Example:

"app_xxxxxxxxxxxxxx"

Body

application/json

Parameters for UpdateApp

​
app_store_description
string | null

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

​
app_type
enum<string> | null

The type of end-user the app is built for, such as consumer or business.

Available options:
b2b_app,
b2c_app,
company_app,
component
​
base_url
string | null

The base production URL where the app is hosted, such as 'https://myapp.example.com'.

Example:

"https://example.com/path"

​
dashboard_path
string | null

The URL path for the company dashboard view of the app, such as '/dashboard'.

​
description
string | null

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

​
discover_path
string | null

The URL path for the discover view of the app, such as '/discover'.

​
experience_path
string | null

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

​
icon
FileInputWithId · object

The icon image for the app, used in listings and navigation.

​
name
string | null

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

​
oauth_client_type
enum<string> | null

How this app authenticates at the OAuth token endpoint.

Available options:
public,
confidential
​
redirect_uris
string[] | null

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

Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.

​
required_scopes
string[] | null

The permission scopes the app will request from users when they install it.

These are the scopes an app can request on behalf of a user

Allowed value: "read_user"
​
status
enum<string> | null

Controls the app's visibility. Set to 'live' to publish on Whop discovery (requires name, icon, and description). Set to 'unlisted' to hide from discovery while keeping the app accessible via direct link.

Available options:
live,
unlisted,
hidden

Response

A successful response

An app is an integration built on Whop. Apps can serve consumers as experiences within products, or serve companies as business tools.

​
id
string
required

The unique identifier for the app.

Example:

"app_xxxxxxxxxxxxxx"

​
name
string
required

The display name of this app shown on the app store and in experience navigation. Maximum 30 characters.

Example:

"Courses"

​
description
string | null
required

A written description of what this app does, displayed on the app store listing page. Null if no description has been set.

Example:

"A comprehensive analytics dashboard for tracking revenue, members, and growth metrics."

​
status
enum<string>
required

The current visibility status of this app on the Whop app store. 'live' means publicly discoverable, 'unlisted' means accessible only via direct link, and 'hidden' means not visible anywhere.

Available options:
live,
unlisted,
hidden
​
base_url
string | null
required

The production base URL where the app is hosted. Null if no base URL is configured.

Example:

"https://myapp.example.com"

​
domain_id
string
required

The unique subdomain identifier for this app's proxied URL on the Whop platform. Forms the URL pattern https://{domain_id}.apps.whop.com.

Example:

"ab1c2d3e4f5g6h7i8j9k"

​
verified
boolean
required

Whether this app has been verified by Whop. Verified apps are endorsed by Whop and displayed in the featured apps section of the app store.

​
app_type
enum<string>
required

The target audience classification for this app (e.g., 'b2b_app', 'b2c_app', 'company_app', 'component').

Available options:
b2b_app,
b2c_app,
company_app,
component
​
experience_path
string | null
required

The URL path template for a specific view of this app, appended to the base domain (e.g., '/experiences/[experienceId]'). Null if the specified view type is not configured.

Example:

"/experiences/[experienceId]"

​
discover_path
string | null
required

The URL path template for a specific view of this app, appended to the base domain (e.g., '/experiences/[experienceId]'). Null if the specified view type is not configured.

Example:

"/experiences/[experienceId]"

​
dashboard_path
string | null
required

The URL path template for a specific view of this app, appended to the base domain (e.g., '/experiences/[experienceId]'). Null if the specified view type is not configured.

Example:

"/experiences/[experienceId]"

​
company
object
required

The company that owns and publishes this app.

​
icon
object
required

The icon image for this app, displayed on the app store, product pages, checkout, and as the default icon for experiences using this app.

​
creator
object
required

The user who created and owns the company that published this app.

​
requested_permissions
object[]
required

The list of permissions this app requests when installed, including both required and optional permissions with justifications.

​
stats
object
required

Aggregate usage statistics for this app, including daily, weekly, and monthly active user counts.

​
api_key
object
required

The API key used to authenticate requests on behalf of this app. Null if no API key has been generated. Requires the 'developer:manage_api_key' permission.

​
redirect_uris
string[]
required

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

Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.