Sign in

a84d4905fdbb

latestOpenAPI 3.1.02026-08-143874115.7 MB
Apps

Create App

Registers a new app on the Whop developer platform. Apps provide custom experiences that can be added to products.

post/apps

Headers

Idempotency-Keystring
Example:d9105228-4a08-46b1-8b91-42fed586d383

A unique key that makes this request safe to retry. See Idempotent requests.

Request body

account_idstring

The account to create the app for (biz_ tag). Defaults to the account behind the presented credential.

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

The type of app to create. Defaults to b2c_app.

base_urlstring nullable

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

namestring required

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

redirect_urisstring[]

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

routestring nullable

The subdomain route where the app's hosted web builds are served, such as myapp for myapp.whop.app.

Example request

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "app_type": "website",
  "base_url": "https://booking.shinetime.example",
  "icon": {
    "direct_upload_id": "eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "id": "file_xxxxxxxxxxxxxx"
  },
  "name": "Shine Time Booking",
  "redirect_uris": [
    "https://booking.shinetime.example/oauth/callback"
  ],
  "route": "shine-time-booking-site"
}

Response

app created

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' | 'website' required

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

base_urlstring nullable required

The production base URL where the app is hosted. null if no base URL is configured, if the caller lacks the developer:basic:read permission on the app's account, or on list responses, which never expose it.

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

{
  "account": {
    "id": "biz_xxxxxxxxxxxxxx",
    "logo_url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "route": "shine-time-holdings",
    "title": "Shine Time Holdings"
  },
  "api_key": {
    "created_at": "2026-01-01T12:00:00.000Z",
    "token": "eyJhbGciOiJFUzI1NiJ9.xxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "app_store_description": "Shine Time Booking turns a whop into a booking calendar. Members pick a package, choose a slot that fits the day's route, and pay up front. A reminder goes out the night before and the receipt lands as soon as the job is signed off.",
  "app_type": "b2c_app",
  "banner_image": {
    "url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  },
  "base_url": "https://booking.shinetime.example",
  "creator": {
    "id": "user_xxxxxxxxxxxxxx",
    "name": "Marcus Webb",
    "username": "marcuswebb"
  },
  "dashboard_path": "/dashboard/[companyId]",
  "default_api_key": {
    "id": "apik_xxxxxxxxxxxxxx",
    "name": "Default",
    "obfuscated_secret_key": "apik_xxxx....xxxx",
    "secret_key": "apik_xxxxxxxxxxxxxx_C0000_C_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "description": "Let members book a mobile detailing appointment without leaving your whop.",
  "discover_path": "/discover",
  "domain_id": "whopappdomain0000001",
  "experience_path": "/experiences/[experienceId]",
  "hosted_url": "https://shine-time-booking.whop.app",
  "icon": {
    "url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  },
  "id": "app_xxxxxxxxxxxxxx",
  "marketplace_status": "not_available",
  "name": "Shine Time Booking",
  "oauth_client_type": "public",
  "openapi_path": "/openapi.json",
  "origin": "https://whopappdomain0000001.apps.whop.com",
  "product_id": "prod_xxxxxxxxxxxxxx",
  "production_android_build": {
    "checksum": "xxxxxxxxxxxxxxxx",
    "file_url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "id": "apbu_xxxxxxxxxxxxxx",
    "source_url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "status": "approved"
  },
  "production_ios_build": {
    "checksum": "xxxxxxxxxxxxxxxx",
    "file_url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "id": "apbu_xxxxxxxxxxxxxx",
    "source_url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "status": "approved"
  },
  "production_web_build": {
    "checksum": "xxxxxxxxxxxxxxxx",
    "file_url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "id": "apbu_xxxxxxxxxxxxxx",
    "source_url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "status": "approved"
  },
  "redirect_uris": [
    "https://booking.shinetime.example/oauth/callback"
  ],
  "requested_permissions": [
    {
      "is_required": true,
      "justification": "Reads basic account info to render the dashboard home.",
      "permission_action": {
        "action": "company:basic:read",
        "name": "company:basic:read"
      }
    }
  ],
  "required_scopes": [
    "read_user"
  ],
  "route": "shine-time-booking",
  "secrets": {
    "BOOKING_CALENDAR_ID": "cal_9f21"
  },
  "skills_path": "/skills",
  "status": "unlisted"
}