Skip to main content
PATCH
/
accounts
/
{account_id}
Update Account
curl --request PATCH \
  --url https://api.whop.com/api/v1/accounts/{account_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "affiliate_application_required": true,
  "affiliate_instructions": "<string>",
  "banner_image": {},
  "business_type": "<string>",
  "description": "<string>",
  "featured_affiliate_product_id": "<string>",
  "industry_group": "<string>",
  "industry_type": "<string>",
  "logo": {},
  "metadata": {},
  "route": "<string>",
  "send_customer_emails": true,
  "social_links": [
    {}
  ],
  "target_audience": "<string>",
  "title": "<string>"
}
'
{
  "banner_image_url": "<string>",
  "business_type": "<string>",
  "created_at": "<string>",
  "description": "<string>",
  "email": "<string>",
  "id": "<string>",
  "industry_group": "<string>",
  "industry_type": "<string>",
  "logo_url": "<string>",
  "metadata": {},
  "parent_account_id": "<string>",
  "route": "<string>",
  "send_customer_emails": true,
  "social_links": [
    {
      "id": "<string>",
      "title": "<string>",
      "url": "<string>"
    }
  ],
  "target_audience": "<string>",
  "title": "<string>",
  "wallet": {
    "address": "<string>",
    "id": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.whop.com/llms.txt

Use this file to discover all available pages before exploring further.

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

account_id
string
required

The ID of the account, which will look like biz_*************

Body

application/json
affiliate_application_required
boolean

Whether prospective affiliates must submit an application before promoting this account.

affiliate_instructions
string | null

Guidelines shown to affiliates promoting this account.

banner_image
object

Attachment input for the account banner image.

business_type
string | null

The high-level business category for the account.

description
string | null

A promotional description for the account.

The ID of the product to feature for affiliates. Pass null to clear.

industry_group
string | null

The industry group the account belongs to.

industry_type
string | null

The specific industry vertical the account operates in.

logo
object

Attachment input for the account logo.

metadata
object

Arbitrary key/value metadata to store on the account.

route
string | null

The unique URL slug for the account.

send_customer_emails
boolean

Whether Whop sends transactional emails to customers on behalf of this account.

The full list of social links to display for the account.

target_audience
string | null

The target audience for this account.

title
string | null

The display name of the account.

Response

account updated

banner_image_url
string | null
required

The URL of the account banner image

business_type
string | null
required

The high-level business category for the account

created_at
string
required

When the account was created, as an ISO 8601 timestamp

description
string | null
required

A promotional description for the account

email
string | null
required

The email address of the account owner

id
string
required

The ID of the account, which will look like biz_*************

industry_group
string | null
required

The industry group the account belongs to

industry_type
string | null
required

The specific industry vertical the account operates in

logo_url
string | null
required

The URL of the account logo image

metadata
object
required

Arbitrary key/value metadata supplied when the account was created

parent_account_id
string | null
required

The parent account ID for connected accounts

route
string
required

The account's public route identifier

send_customer_emails
boolean
required

Whether Whop sends transactional emails to customers on behalf of this account

target_audience
string | null
required

The target audience for this account

title
string
required

The display name of the account

wallet
object
required

The account's primary crypto wallet, or null if none has been provisioned