> ## 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.

# Update company

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

Required permissions:
 - `company:update`
 - `company:basic:read`



## OpenAPI

````yaml https://app.stainless.com/api/spec/documented/whopsdk/openapi.documented.yml patch /companies/{id}
openapi: 3.1.0
info:
  title: Whop API
  description: >-
    The Whop REST API. Please see
    https://docs.whop.com/developer/api/getting-started for more details.
  termsOfService: https://whop.com/tos-developer-api/
  version: 1.0.0
servers:
  - url: https://api.whop.com/api/v1
    description: Production Whop API
security: []
tags:
  - name: Products
    description: Products
  - name: Plans
    description: Plans
  - name: Payments
    description: Payments
  - name: Refunds
    description: Refunds
  - name: Disputes
    description: Disputes
  - name: Dispute alerts
    description: Dispute alerts
  - name: Resolution center cases
    description: Resolution center cases
  - name: Checkout configurations
    description: Checkout configurations
  - name: Setup intents
    description: Setup intents
  - name: Payment methods
    description: Payment methods
  - name: Invoices
    description: Invoices
  - name: Promo codes
    description: Promo codes
  - name: Card transactions
    description: Card transactions
  - name: Ledger accounts
    description: Ledger accounts
  - name: Transfers
    description: Transfers
  - name: Withdrawals
    description: Withdrawals
  - name: Payout methods
    description: Payout methods
  - name: Verifications
    description: Verifications
  - name: Payout accounts
    description: Payout accounts
  - name: Topups
    description: Topups
  - name: Users
    description: Users
  - name: Companies
    description: Companies
  - name: Authorized users
    description: Authorized users
  - name: Fee markups
    description: Fee markups
  - name: Members
    description: Members
  - name: Memberships
    description: Memberships
  - name: Leads
    description: Leads
  - name: Entries
    description: Entries
  - name: Shipments
    description: Shipments
  - name: Reviews
    description: Reviews
  - name: Company token transactions
    description: Company token transactions
  - name: Affiliates
    description: Affiliates
  - name: Experiences
    description: Experiences
  - name: Forums
    description: Forums
  - name: Forum posts
    description: Forum posts
  - name: Chat channels
    description: Chat channels
  - name: Support channels
    description: Support channels
  - name: Messages
    description: Messages
  - name: Reactions
    description: Reactions
  - name: Dm members
    description: Dm members
  - name: Dm channels
    description: Dm channels
  - name: Notifications
    description: Notifications
  - name: Courses
    description: Courses
  - name: Course chapters
    description: Course chapters
  - name: Course lessons
    description: Course lessons
  - name: Course students
    description: Course students
  - name: Course lesson interactions
    description: Course lesson interactions
  - name: Apps
    description: Apps
  - name: Webhooks
    description: Webhooks
  - name: App builds
    description: App builds
  - name: Access tokens
    description: Access tokens
  - name: Account links
    description: Account links
  - name: Files
    description: Files
  - name: Ai chats
    description: Ai chats
  - name: Bounties
    description: Bounties
  - name: Stats
    description: Stats
  - name: Ad campaigns
    description: Ad campaigns
  - name: Ad groups
    description: Ad groups
  - name: Ads
    description: Ads
  - name: Conversions
    description: Conversions
paths:
  /companies/{id}:
    patch:
      tags:
        - Companies
      summary: Update company
      description: |-
        Update a company's title, description, logo, and other settings.

        Required permissions:
         - `company:update`
         - `company:basic:read`
      operationId: updateCompany
      parameters:
        - name: id
          in: path
          required: true
          description: The unique identifier of the company to update.
          schema:
            type: string
            example: biz_xxxxxxxxxxxxxx
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                affiliate_application_required:
                  type:
                    - boolean
                    - 'null'
                  description: >-
                    Whether prospective affiliates must submit an application
                    before they can promote this company.
                affiliate_instructions:
                  type:
                    - string
                    - 'null'
                  description: >-
                    Guidelines and instructions shown to affiliates explaining
                    how to promote this company's products.
                banner_image:
                  type:
                    - object
                    - 'null'
                  properties:
                    id:
                      type: string
                      description: The ID of an existing file object.
                  required:
                    - id
                  description: The company's banner image. Accepts PNG or JPEG format.
                  title: FileInputWithId
                description:
                  type:
                    - string
                    - 'null'
                  description: >-
                    A promotional pitch displayed to potential customers on the
                    company's store page.
                featured_affiliate_product_id:
                  type:
                    - string
                    - 'null'
                  description: >-
                    The ID of the product to feature on this company's affiliate
                    page. Pass null to clear.
                logo:
                  type:
                    - object
                    - 'null'
                  properties:
                    id:
                      type: string
                      description: The ID of an existing file object.
                  required:
                    - id
                  description: The company's logo image. Accepts PNG, JPEG, or GIF format.
                  title: FileInputWithId
                route:
                  type:
                    - string
                    - 'null'
                  description: >-
                    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_emails:
                  type:
                    - boolean
                    - 'null'
                  description: >-
                    Whether Whop sends transactional emails (receipts, renewals,
                    cancelations) to customers on behalf of this company.
                social_links:
                  type:
                    - array
                    - 'null'
                  items:
                    type: object
                    properties:
                      image:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            description: The ID of an existing file object.
                        required:
                          - id
                        description: The custom image for the social link
                        title: FileInputWithId
                      order:
                        type:
                          - string
                          - 'null'
                        description: The order of the social link
                        example: '123.45'
                      title:
                        type:
                          - string
                          - 'null'
                        description: The title of the social link
                      url:
                        type: string
                        description: The URL of the social link
                        example: https://example.com/path
                      website:
                        $ref: '#/components/schemas/SocialLinkWebsites'
                        description: The website this link is for
                      website_order:
                        type:
                          - string
                          - 'null'
                        description: The order of the website social link
                        example: '123.45'
                    required:
                      - url
                      - website
                    description: Input for creating a social link for a company
                  description: >-
                    The social media links to display on the company's store
                    page. Pass the full list of desired social links — any
                    existing links not included will be removed.
                target_audience:
                  type:
                    - string
                    - 'null'
                  description: >-
                    The target audience for this company (e.g., 'beginner day
                    traders aged 18-25 looking to learn options').
                title:
                  type:
                    - string
                    - 'null'
                  description: The display name of the company shown to customers.
              required: []
              description: Parameters for UpdateCompany
      responses:
        '200':
          description: A successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Company'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      message:
                        type: string
                      code:
                        type:
                          - string
                          - 'null'
                        description: >-
                          A short string indicating the specific error code,
                          e.g. 'parameter_missing', 'parameter_invalid',
                          'invalid_json'
                      param:
                        type:
                          - string
                          - 'null'
                        description: The parameter that caused the error, if applicable
                    required:
                      - type
                      - message
                required:
                  - error
              example:
                error:
                  type: invalid_request_error
                  code: parameter_missing
                  message: 'Missing required parameter: amount.'
                  param: amount
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      message:
                        type: string
                      code:
                        type:
                          - string
                          - 'null'
                        description: >-
                          A short string indicating the specific error code,
                          e.g. 'parameter_missing', 'parameter_invalid',
                          'invalid_json'
                      param:
                        type:
                          - string
                          - 'null'
                        description: The parameter that caused the error, if applicable
                    required:
                      - type
                      - message
                required:
                  - error
              example:
                error:
                  type: unauthorized
                  message: Invalid or missing API key
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      message:
                        type: string
                      code:
                        type:
                          - string
                          - 'null'
                        description: >-
                          A short string indicating the specific error code,
                          e.g. 'parameter_missing', 'parameter_invalid',
                          'invalid_json'
                      param:
                        type:
                          - string
                          - 'null'
                        description: The parameter that caused the error, if applicable
                    required:
                      - type
                      - message
                required:
                  - error
              example:
                error:
                  type: forbidden
                  message: You do not have permission to access this resource
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      message:
                        type: string
                      code:
                        type:
                          - string
                          - 'null'
                        description: >-
                          A short string indicating the specific error code,
                          e.g. 'parameter_missing', 'parameter_invalid',
                          'invalid_json'
                      param:
                        type:
                          - string
                          - 'null'
                        description: The parameter that caused the error, if applicable
                    required:
                      - type
                      - message
                required:
                  - error
              example:
                error:
                  type: not_found
                  message: Resource not found
        '422':
          description: Verification required
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      message:
                        type: string
                      code:
                        type:
                          - string
                          - 'null'
                        description: >-
                          A short string indicating the specific error code,
                          e.g. 'parameter_missing', 'parameter_invalid',
                          'invalid_json'
                      param:
                        type:
                          - string
                          - 'null'
                        description: The parameter that caused the error, if applicable
                    required:
                      - type
                      - message
                required:
                  - error
              example:
                error: null
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      message:
                        type: string
                      code:
                        type:
                          - string
                          - 'null'
                        description: >-
                          A short string indicating the specific error code,
                          e.g. 'parameter_missing', 'parameter_invalid',
                          'invalid_json'
                      param:
                        type:
                          - string
                          - 'null'
                        description: The parameter that caused the error, if applicable
                    required:
                      - type
                      - message
                required:
                  - error
              example:
                error:
                  type: internal_server_error
                  message: An unexpected error occurred
      security:
        - bearerAuth:
            - company:update
            - company:basic:read
      x-codeSamples:
        - lang: JavaScript
          source: |-
            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);
        - lang: Python
          source: |-
            import os
            from whop_sdk import Whop

            client = Whop(
                api_key=os.environ.get("WHOP_API_KEY"),  # This is the default and can be omitted
            )
            company = client.companies.update(
                id="biz_xxxxxxxxxxxxxx",
            )
            print(company.id)
        - lang: Ruby
          source: |-
            require "whop_sdk"

            whop = WhopSDK::Client.new(api_key: "My API Key")

            company = whop.companies.update("biz_xxxxxxxxxxxxxx")

            puts(company)
components:
  schemas:
    SocialLinkWebsites:
      type: string
      enum:
        - x
        - instagram
        - facebook
        - tiktok
        - youtube
        - linkedin
        - twitch
        - website
        - custom
      description: The different websites you can have social links for
    Company:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the company.
          example: biz_xxxxxxxxxxxxxx
        title:
          type: string
          description: The display name of the company shown to customers.
          example: Pickaxe
        description:
          type:
            - string
            - 'null'
          description: >-
            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:
          type: boolean
          description: >-
            Whether this company has been verified by Whop's trust and safety
            team.
        send_customer_emails:
          type: boolean
          description: >-
            Whether Whop sends transactional emails (receipts, updates) to
            customers on behalf of this company.
        created_at:
          type: string
          format: date-time
          description: The datetime the company was created.
          example: '2023-12-01T05:00:00.401Z'
        updated_at:
          type: string
          format: date-time
          description: The datetime the company was last updated.
          example: '2023-12-01T05:00:00.401Z'
        member_count:
          type: integer
          description: >-
            The total number of users who currently hold active memberships
            across all of this company's products.
          example: 42
        owner_user:
          type: object
          properties:
            id:
              type: string
              description: The unique identifier for the user.
              example: user_xxxxxxxxxxxxx
            name:
              type:
                - string
                - 'null'
              description: The user's display name shown on their public profile.
              example: John Doe
            username:
              type: string
              description: The user's unique username shown on their public profile.
              example: johndoe42
          required:
            - id
            - name
            - username
          description: >-
            The user who owns and has full administrative control over this
            company.
        route:
          type: string
          description: >-
            The URL slug for the company's store page (e.g., 'pickaxe' in
            whop.com/pickaxe).
          example: pickaxe
        logo:
          type:
            - object
            - 'null'
          properties:
            url:
              type:
                - string
                - 'null'
              description: >-
                A pre-optimized URL for rendering this attachment on the client.
                This should be used for displaying attachments in apps.
              example: https://media.whop.com/abc123/optimized.jpg
          required:
            - url
          description: The company's logo.
        published_reviews_count:
          type: integer
          description: >-
            The total number of published customer reviews across all products
            for this company.
          example: 42
        metadata:
          type:
            - object
            - 'null'
          additionalProperties: true
          description: >-
            A key-value JSON object of custom metadata for this company, managed
            by the platform that created the account.
        target_audience:
          type:
            - string
            - 'null'
          description: The target audience for the company. Null if not set.
        social_links:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The unique identifier for the social link.
                example: soci_xxxxxxxxxxxxx
              url:
                type: string
                description: The URL of the social media profile or external link.
                example: https://x.com/whop
              website:
                $ref: '#/components/schemas/SocialLinkWebsites'
                description: The website
            required:
              - id
              - url
              - website
            description: A social link attached to a resource on the site.
          description: >-
            The list of social media accounts and external links associated with
            this company.
        affiliate_instructions:
          type:
            - string
            - 'null'
          description: >-
            Guidelines and instructions provided to affiliates explaining how to
            promote this company's products.
          example: Share your unique link on social media to earn 20% commission.
        featured_affiliate_product:
          type:
            - object
            - 'null'
          properties:
            id:
              type: string
              description: The unique identifier for the product.
              example: prod_xxxxxxxxxxxxx
            name:
              type: string
              description: >-
                The display name of the product shown to customers. Maximum 50
                characters.
          required:
            - id
            - name
          description: >-
            The product featured for affiliates to promote on this company's
            affiliate page. Null if none is configured.
      required:
        - id
        - title
        - description
        - verified
        - send_customer_emails
        - created_at
        - updated_at
        - member_count
        - owner_user
        - route
        - logo
        - published_reviews_count
        - metadata
        - target_audience
        - social_links
        - affiliate_instructions
        - featured_affiliate_product
      description: >-
        A company is a seller on Whop. Companies own products, manage members,
        and receive payouts.
  securitySchemes:
    bearerAuth:
      type: http
      description: >-
        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 ***************************`
      scheme: bearer
      bearerFormat: auth-scheme

````