Sign in

a84d4905fdbb

latestOpenAPI 3.1.02026-08-143874115.7 MB
Products

Update Product

Updates an existing product.

patch/products/{id}

Request body

descriptionstring nullable

A written description displayed on the product page.

headlinestring nullable

A short marketing headline for the product page.

metadataobject nullable

Custom key-value pairs to store on the product.

product_tax_code_idstring nullable

The unique identifier of the tax classification code. See the available product categories.

send_welcome_messageboolean nullable

Whether to send an automated welcome message via support chat when a user joins this product.

titlestring

The display name of the product.

visibilitystring

Whether the product is visible to customers.

Example request

{
  "banner_image": {
    "direct_upload_id": "eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "id": "file_xxxxxxxxxxxxxx"
  },
  "description": "Full interior extraction, leather conditioning, and an ozone odor treatment.",
  "headline": "Steam, shampoo, and odor removal in one visit",
  "metadata": {
    "bay": "1",
    "duration_hours": "4"
  },
  "product_tax_code_id": "ptc_xxxxxxxxxxxxxx",
  "send_welcome_message": true,
  "title": "Interior Deep Clean",
  "visibility": "visible"
}

Response

product tax code updated

accountobject nullable required

Account that sells this product.

created_atstring required

When the product was created, as an ISO 8601 timestamp.

custom_cta'get_access' | 'join' | 'order_now' | 'shop_now' | 'call_now' | 'donate_now' | 'contact_us' | 'sign_up' | 'subscribe' | 'purchase' | 'get_offer' | 'apply_now' | 'complete_order' | 'null' nullable required

Call-to-action button label shown on the product purchase page.

custom_cta_urlstring nullable required

URL the call-to-action button links to instead of checkout.

custom_statement_descriptorstring nullable required

Custom text label on customer's bank statement.

descriptionstring nullable required

Written description displayed on product page.

external_identifierstring nullable required

External identifier stored on the product for your own reference.

global_affiliate_percentagenumber nullable required

Commission rate affiliates earn through the global affiliate program.

global_affiliate_status'enabled' | 'disabled' | 'null' nullable required

Enrollment status in the global affiliate program.

headlinestring nullable required

Short marketing headline displayed on product page.

idstring required

Product ID, prefixed prod_.

marketplace_status'not_available' | 'pending_review' | 'live_marketplace' required

Listing state on the whop.com marketplace. pending_review means submitted and awaiting review; live_marketplace means approved and discoverable.

member_affiliate_percentagenumber nullable required

Commission rate members earn through the member affiliate program.

member_affiliate_status'enabled' | 'disabled' | 'null' nullable required

Enrollment status in the member affiliate program.

member_countnumber required

Active memberships for this product; 0 if public member counts are disabled.

metadataobject nullable required

Custom key-value pairs stored on the product.

owner_userobject nullable required

User who owns the account selling this product.

product_tax_codeobject nullable required

Tax classification code for this product, or null if no tax code is set.

published_reviews_countnumber required

Published customer reviews for this product.

routestring required

URL slug for the product's public link.

titlestring required

Product display name shown to customers.

updated_atstring required

When the product was last updated, as an ISO 8601 timestamp.

verifiedboolean required

Whether the product has been verified by Whop.

visibilitystring nullable required

Whether the product is publicly visible, hidden, or archived.

Example response

{
  "account": {
    "id": "biz_xxxxxxxxxxxxxx",
    "route": "biz_xxxxxxxxxxxxxx",
    "title": "Shine Time Auto Detailing"
  },
  "created_at": "2026-01-01T12:00:00.000Z",
  "custom_cta": "order_now",
  "custom_cta_url": "https://shinetime.example/book",
  "custom_statement_descriptor": "WHOP*SHINETIME",
  "description": "Full interior extraction, leather conditioning, and an ozone odor treatment.",
  "external_identifier": "SHINE-CERAMIC-01",
  "gallery_images": [
    {
      "content_type": "image/png",
      "id": "file_xxxxxxxxxxxxxx",
      "url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    }
  ],
  "global_affiliate_percentage": 10,
  "global_affiliate_status": "enabled",
  "headline": "Steam, shampoo, and odor removal in one visit",
  "id": "prod_xxxxxxxxxxxxxx",
  "marketplace_status": "not_available",
  "member_affiliate_percentage": 5,
  "member_affiliate_status": "enabled",
  "metadata": {
    "bay": "1",
    "duration_hours": "4"
  },
  "owner_user": {
    "id": "user_xxxxxxxxxxxxxx",
    "name": "Marcus Webb",
    "username": "marcuswebb"
  },
  "product_tax_code": {
    "id": "ptc_xxxxxxxxxxxxxx",
    "name": "General - Digital Goods",
    "product_type": "digital"
  },
  "route": "interior-deep-clean",
  "title": "Interior Deep Clean",
  "updated_at": "2026-01-01T12:00:00.000Z",
  "visibility": "visible"
}