Skip to main content
PATCH
/
companies
/
{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 company = await client.companies.update('biz_xxxxxxxxxxxxxx');

console.log(company.id);
{
  "id": "biz_xxxxxxxxxxxxxx",
  "title": "Pickaxe",
  "description": "Learn the fundamentals of data analytics with hands-on projects.",
  "verified": true,
  "business_type": "education_program",
  "industry_type": "trading",
  "send_customer_emails": true,
  "created_at": "2023-12-01T05:00:00.401Z",
  "updated_at": "2023-12-01T05:00:00.401Z",
  "member_count": 42,
  "owner_user": {
    "id": "user_xxxxxxxxxxxxx",
    "name": "John Doe",
    "username": "johndoe42"
  },
  "route": "pickaxe",
  "logo": {
    "url": "https://media.whop.com/abc123/optimized.jpg"
  },
  "published_reviews_count": 42,
  "metadata": {},
  "social_links": [
    {
      "id": "soci_xxxxxxxxxxxxx",
      "url": "https://x.com/whop",
      "website": "x"
    }
  ]
}

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 company to update.

Example:

"biz_xxxxxxxxxxxxxx"

Body

application/json

Parameters for UpdateCompany

​
banner_image
FileInputWithId · object

The company's banner image. Accepts PNG or JPEG format.

​
business_type
enum<string> | null

The high-level business category for the company (e.g., education_program, coaching, software).

Available options:
education_program,
coaching,
software,
paid_group,
newsletter,
agency,
physical_products,
brick_and_mortar,
events,
coaching_and_courses,
other,
saas,
course,
community
​
description
string | null

A promotional pitch displayed to potential customers on the company's store page.

​
industry_group
enum<string> | null

The industry group the company belongs to.

Available options:
academic_and_test_prep,
accessories,
ai_and_automation_agencies,
ai_and_automation_software,
arts_and_crafts,
automotive,
b2b_and_professional_marketplaces,
baby_and_kids,
beauty_and_personal_care,
beauty_and_wellness,
business_and_entrepreneurship,
business_and_money_groups,
career_and_professional,
charity_and_cause_events,
clothing_and_apparel,
communication_and_messaging_software,
community_and_education_software,
consulting,
content_and_clipping_agencies,
creative_and_content_creation,
creative_and_content_groups,
creative_and_education,
creative_gigs,
creative_services,
customer_support_agencies,
dating_and_relationships,
delivery_and_logistics,
dental_and_vision,
dermatology_and_skin,
design_and_creative_agencies,
developer_and_technical_tools,
development_agencies,
digital_and_education_marketplaces,
e_commerce_software,
education_and_business_events,
education_and_childcare,
electronics_and_gadgets,
entertainment_and_leisure,
entertainment_events,
family_and_community_events,
finance_and_investing,
fitness_and_athletics,
fitness_and_health_groups,
fitness_and_recreation,
fitness_equipment_and_gear,
food_and_beverage,
food_and_beverages,
food_and_hospitality_marketplaces,
gaming_and_entertainment_software,
gaming_groups,
genetic_and_specialized,
government_and_public,
health_and_wellness,
health_and_wellness_services,
healthcare,
healthcare_and_wellness_software,
hobbies_and_lifestyle,
hobby_and_interest_groups,
home_and_living,
home_and_trade_services,
home_and_trade_storefronts,
home_services_gigs,
hospitality_and_lodging,
industry_specific_software,
language_and_communication,
legal_and_compliance,
lifestyle_and_culture,
lifestyle_and_personal_growth_groups,
lifestyle_and_wellness_events,
logistics_and_transportation_services,
marketing_agencies,
marketing_and_advertising,
marketing_and_sales_software,
mental_health_and_behavioral,
miscellaneous,
music_and_performing_arts,
news_and_politics,
nonprofit_and_charity,
office_and_business_supplies,
outdoor_and_sports,
personal_development,
personal_finance,
personal_services,
pet_services,
pets_and_animals,
primary_and_general_care,
product_marketplaces,
productivity_and_business_ops,
professional_gigs,
professional_services,
professional_services_storefront,
publishing_and_info_products,
real_estate,
real_estate_software,
recruiting_and_staffing,
rehabilitation_and_therapy,
rental_marketplaces,
retail,
sales_agencies,
sales_and_revenue,
security_and_privacy_software,
service_marketplaces,
sleep_and_chronic_conditions,
social_and_networking_events,
specialized_gigs,
specialty_medical_care,
spirituality_and_mindfulness,
spirituality_and_personal_growth,
sports_and_fitness_events,
sports_betting_and_gambling,
sports_betting_groups,
supplements_and_nutrition,
sustainability_and_eco_products,
task_and_errands,
tech_and_ai,
tech_and_dev_groups,
tech_and_development,
trading_and_finance_software,
trading_and_investing,
trading_and_investing_groups,
transportation,
veterinary,
video_games_and_esports,
weight_and_metabolic_health,
wellness_and_alternative,
womens_and_mens_health
​
industry_type
enum<string> | null

The specific industry vertical the company operates in (e.g., fitness, trading, real_estate).

Available options:
trading,
sports_betting,
reselling,
fitness,
amazon_fba,
real_estate,
kindle_book_publishing,
dating,
agencies,
health_and_wellness,
social_media,
sales,
business,
ecommerce,
video_games,
home_services,
ai,
public_speaking,
personal_finance,
careers,
travel,
clipping,
spirituality,
vas,
personal_development,
software,
other,
marketing_agency,
sales_agency,
ai_agency,
design_agency,
coaching_agency,
development_agency,
recruiting_agency,
customer_support_agency,
clipping_agency,
clothing,
supplements,
beauty_and_personal_care,
fitness_gear,
accessories,
home_goods,
electronics_and_gadgets,
food_and_beverages,
gym,
restaurant,
retail_store,
coffee_shop,
salon_spa,
medical_dentist_office,
hotel_lodging,
auto_repair_shop,
masterminds,
webinars,
bootcamps,
convention,
concerts,
meetups,
parties
​
logo
FileInputWithId · object

The company's logo image. Accepts PNG, JPEG, or GIF format.

​
send_customer_emails
boolean | null

Whether Whop sends transactional emails (receipts, renewals, cancelations) to customers on behalf of this company.

​
title
string | null

The display name of the company shown to customers.

Response

A successful response

A company is a seller on Whop. Companies own products, manage members, and receive payouts.

​
id
string
required

The unique identifier for the company.

Example:

"biz_xxxxxxxxxxxxxx"

​
title
string
required

The display name of the company shown to customers.

Example:

"Pickaxe"

​
description
string | null
required

A promotional pitch written by the company creator, displayed to potential customers on the store page.

Example:

"Learn the fundamentals of data analytics with hands-on projects."

​
verified
boolean
required

Whether this company has been verified by Whop's trust and safety team.

​
business_type
enum<string> | null
required

The high-level business category for the company (e.g., education_program, coaching, software). Null if not classified.

Available options:
education_program,
coaching,
software,
paid_group,
newsletter,
agency,
physical_products,
brick_and_mortar,
events,
coaching_and_courses,
other,
saas,
course,
community
​
industry_type
enum<string> | null
required

The specific industry vertical the company operates in (e.g., fitness, trading, real_estate). Null if not classified.

Available options:
trading,
sports_betting,
reselling,
fitness,
amazon_fba,
real_estate,
kindle_book_publishing,
dating,
agencies,
health_and_wellness,
social_media,
sales,
business,
ecommerce,
video_games,
home_services,
ai,
public_speaking,
personal_finance,
careers,
travel,
clipping,
spirituality,
vas,
personal_development,
software,
other,
marketing_agency,
sales_agency,
ai_agency,
design_agency,
coaching_agency,
development_agency,
recruiting_agency,
customer_support_agency,
clipping_agency,
clothing,
supplements,
beauty_and_personal_care,
fitness_gear,
accessories,
home_goods,
electronics_and_gadgets,
food_and_beverages,
gym,
restaurant,
retail_store,
coffee_shop,
salon_spa,
medical_dentist_office,
hotel_lodging,
auto_repair_shop,
masterminds,
webinars,
bootcamps,
convention,
concerts,
meetups,
parties
​
send_customer_emails
boolean
required

Whether Whop sends transactional emails (receipts, updates) to customers on behalf of this company.

​
created_at
string<date-time>
required

The datetime the company was created.

Example:

"2023-12-01T05:00:00.401Z"

​
updated_at
string<date-time>
required

The datetime the company was last updated.

Example:

"2023-12-01T05:00:00.401Z"

​
member_count
integer
required

The total number of users who currently hold active memberships across all of this company's products.

Example:

42

​
owner_user
object
required

The user who owns and has full administrative control over this company.

​
route
string
required

The URL slug for the company's store page (e.g., 'pickaxe' in whop.com/pickaxe).

Example:

"pickaxe"

​
logo
object
required

The company's logo.

​
published_reviews_count
integer
required

The total number of published customer reviews across all products for this company.

Example:

42

​
metadata
object
required

A key-value JSON object of custom metadata for this company, managed by the platform that created the account.

​
social_links
object[]
required

The list of social media accounts and external links associated with this company.