> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lighton.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a company workspace

> ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.

Partially update a given workspace. The authenticated user must be a company or instance-level administrator.

**Fields:**
- **name** (string, optional): Desired workspace name
- **description** (string, optional): Desired workspace description. Send empty string or null to clear.

**Permissions:**
- Company Admins can update workspaces within their company
- Instance-level administrators can update any workspace



## OpenAPI

````yaml /api-reference/openapi-v3-company.yaml patch /api/v3/company/workspaces/{id}
openapi: 3.0.3
info:
  title: Paradigm API
  version: xenial-xerus (v3-company)
  description: >-
    A versatile and adaptable tool designed to integrate Generative AI into your
    applications
servers:
  - url: https://paradigm.lighton.ai
security: []
tags:
  - name: Workspaces
    description: Operations about workspaces
paths:
  /api/v3/company/workspaces/{id}:
    patch:
      tags:
        - Workspaces
      summary: Update a company workspace
      description: >-
        ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to
        breaking changes. Use with caution in production environments.


        Partially update a given workspace. The authenticated user must be a
        company or instance-level administrator.


        **Fields:**

        - **name** (string, optional): Desired workspace name

        - **description** (string, optional): Desired workspace description.
        Send empty string or null to clear.


        **Permissions:**

        - Company Admins can update workspaces within their company

        - Instance-level administrators can update any workspace
      operationId: api_v3_company_workspaces_partial_update
      parameters:
        - in: path
          name: id
          schema:
            type: integer
          description: The unique identifier of the workspace.
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedCompanyWorkspaceUpdateV3Request'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedCompanyWorkspaceUpdateV3Request'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedCompanyWorkspaceUpdateV3Request'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyWorkspaceV3DetailsResponse'
          description: Workspace updated successfully
        '400':
          description: >-
            Bad Request - Invalid input parameters (empty name, name too long,
            unsupported fields, etc.)
        '401':
          description: Unauthenticated - Missing or invalid API key/session cookie
        '403':
          description: >-
            Unauthorized - User does not have permission to update company
            workspaces
        '404':
          description: Not Found - Workspace does not exist or belongs to another company
        '409':
          description: Conflict - Workspace name already exists in the company
      security:
        - bearerAuth: []
components:
  schemas:
    PatchedCompanyWorkspaceUpdateV3Request:
      type: object
      description: V3 Request serializer for updating a workspace in the user's company.
      properties:
        name:
          type: string
          maxLength: 100
        description:
          type: string
    CompanyWorkspaceV3DetailsResponse:
      type: object
      description: V3 Response serializer for company workspace creation and retrieval.
      properties:
        id:
          type: integer
        name:
          type: string
        workspace_type:
          type: string
        document_upload_method:
          type: string
        description:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        user_role:
          type: string
          readOnly: true
        used_storage:
          type: number
          format: double
        files_count:
          type: integer
      required:
        - created_at
        - description
        - document_upload_method
        - files_count
        - id
        - name
        - updated_at
        - used_storage
        - user_role
        - workspace_type
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer authentication header of the form `Bearer <token>`, where
        `<token>` is your auth token.

````