Sign in

v8

OpenAPI 3.1.02026-08-033623795.0 MB
Companies

Update company

Update a company's title, description, logo, and other settings.

Required permissions:

  • company:update
  • company:basic:read
patch/companies/{id}

Path parameters

idstring required
Example:biz_xxxxxxxxxxxxxx

The unique identifier of the company to update.

Request body

affiliate_application_requiredboolean nullable

Whether prospective affiliates must submit an application before they can promote this company.

affiliate_instructionsstring nullable

Guidelines and instructions shown to affiliates explaining how to promote this company's products.

descriptionstring nullable

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

featured_affiliate_product_idstring nullable

The ID of the product to feature on this company's affiliate page. Pass null to clear.

routestring nullable

The unique URL slug for the company's store page. Must be lowercase and can include hyphens (e.g., 'my-company'). If not provided, the route will remain unchanged.

send_customer_emailsboolean nullable

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

target_audiencestring nullable

The target audience for this company (e.g., 'beginner day traders aged 18-25 looking to learn options').

titlestring nullable

The display name of the company shown to customers.

Example request

{
  "social_links": [
    {
      "order": "123.45",
      "url": "https://example.com/path",
      "website_order": "123.45"
    }
  ]
}

Response

A successful response

affiliate_instructionsstring nullable required

Guidelines and instructions provided to affiliates explaining how to promote this company's products.

created_atstring date-time required

The datetime the company was created.

descriptionstring nullable required

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

idstring required

The unique identifier for the company.

member_countinteger required

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

metadataobject nullable required

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

published_reviews_countinteger required

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

routestring required

URL slug for the account's store page, e.g. pickaxe in whop.com/pickaxe.

send_customer_emailsboolean required

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

target_audiencestring nullable required

The target audience for the company. Null if not set.

titlestring required

The display name of the company shown to customers.

updated_atstring date-time required

The datetime the company was last updated.

verifiedboolean required

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

Example response

{
  "affiliate_instructions": "Share your unique link on social media to earn 20% commission.",
  "created_at": "2023-12-01T05:00:00.401Z",
  "description": "Learn the fundamentals of data analytics with hands-on projects.",
  "featured_affiliate_product": {
    "id": "prod_xxxxxxxxxxxxx"
  },
  "id": "biz_xxxxxxxxxxxxxx",
  "logo": {
    "url": "https://media.whop.com/abc123/optimized.jpg"
  },
  "member_count": 42,
  "owner_user": {
    "id": "user_xxxxxxxxxxxxx",
    "name": "John Doe",
    "username": "johndoe42"
  },
  "published_reviews_count": 42,
  "route": "pickaxe",
  "social_links": [
    {
      "id": "soci_xxxxxxxxxxxxx",
      "url": "https://x.com/whop"
    }
  ],
  "title": "Pickaxe",
  "updated_at": "2023-12-01T05:00:00.401Z"
}