> ## 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 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 an owner of the workspace.

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

**Restrictions:**
- Only CUSTOM workspaces can be updated (PERSONAL and COMPANY workspaces cannot be modified)
- Only workspace OWNER can update (EDITOR role, instance admins, and company admins cannot use this endpoint)
- Only name and description can be updated (members cannot be updated via this endpoint)

**Note:** To update workspace members, use the dedicated member management endpoints.



## OpenAPI

````yaml /api-reference/openapi-v3.yaml patch /api/v3/workspaces/{id}
openapi: 3.0.3
info:
  title: Paradigm API
  version: xenial-xerus (v3)
  description: >-
    A versatile and adaptable tool designed to integrate Generative AI into your
    applications
servers:
  - url: https://paradigm.lighton.ai
security: []
tags:
  - name: Agents
    description: Operations about agents
  - name: Threads
    description: Operations about agents conversation threads
  - name: Tools
    description: Operations about native tools
  - name: Models
    description: Operations about AI models
  - name: MCP
    description: Operations about MCP servers
  - name: Sources
    description: Operations about sources used by agents conversation threads
  - name: Artifacts
    description: Operations about artifacts generated by agents conversation threads
  - name: Agent
    description: >-
      Operations about agents (deprecated). Please use the 'Agents' API
      component instead.
  - name: Files
    description: Operations about files
  - name: Files Processing
    description: Operations about files processing
  - name: Tags
    description: Operations about tags
  - name: Workspaces
    description: Operations about workspaces
  - name: Users
    description: Operations about users
  - name: User Groups
    description: Operations about user groups
  - name: Companies
    description: Operations about companies
  - name: SCIM
    description: Operations about SCIM
paths:
  /api/v3/workspaces/{id}:
    patch:
      tags:
        - Workspaces
      summary: Update a 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 an
        owner of the workspace.


        **Fields:**

        - **name** (string, optional): Desired workspace name (max 100
        characters, cannot be empty)

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


        **Restrictions:**

        - Only CUSTOM workspaces can be updated (PERSONAL and COMPANY workspaces
        cannot be modified)

        - Only workspace OWNER can update (EDITOR role, instance admins, and
        company admins cannot use this endpoint)

        - Only name and description can be updated (members cannot be updated
        via this endpoint)


        **Note:** To update workspace members, use the dedicated member
        management endpoints.
      operationId: api_v3_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/PatchedUpdateWorkspaceV3Request'
            examples:
              UpdateWorkspaceNameAndDescription:
                value:
                  name: Updated Workspace Name
                  description: Updated description
                summary: Update workspace name and description
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedUpdateWorkspaceV3Request'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedUpdateWorkspaceV3Request'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardWorkspaceV3DetailsResponse'
          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 must be workspace owner and workspace must be
            custom type
        '404':
          description: Not Found - Workspace does not exist or belongs to another company
      security:
        - bearerAuth: []
components:
  schemas:
    PatchedUpdateWorkspaceV3Request:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        members:
          description: >-
            Members with roles in format {"users": [{"id": <user_id>, "role":
            "owner|editor|viewer"}, ...], "groups": [{"id": <group_id>, "role":
            "owner|editor|viewer"}, ...]}. Role defaults to viewer if not
            specified. REPLACES all existing members.
    StandardWorkspaceV3DetailsResponse:
      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
        summaries:
          type: array
          items:
            $ref: '#/components/schemas/WorkspaceSummary'
          readOnly: true
      required:
        - created_at
        - description
        - document_upload_method
        - files_count
        - id
        - name
        - summaries
        - updated_at
        - used_storage
        - user_role
        - workspace_type
    WorkspaceSummary:
      type: object
      properties:
        language:
          type: string
        summary:
          type: string
      required:
        - language
        - summary
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer authentication header of the form `Bearer <token>`, where
        `<token>` is your auth token.

````