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

# Replace all workspace members

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

Bulk replace the entire list of members for a custom workspace. This endpoint can only be used by instance level admins.



## OpenAPI

````yaml /api-reference/openapi-v3-instance.yaml put /api/v3/instance/workspaces/{id}/members
openapi: 3.0.3
info:
  title: Paradigm API
  version: xenial-xerus (v3-instance)
  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/instance/workspaces/{id}/members:
    put:
      tags:
        - Workspaces
      summary: Replace all workspace members
      description: >-
        ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to
        breaking changes. Use with caution in production environments.


        Bulk replace the entire list of members for a custom workspace. This
        endpoint can only be used by instance level admins.
      operationId: api_v3_instance_workspaces_members_update
      parameters:
        - in: path
          name: id
          schema:
            type: integer
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstanceWorkspaceSetMembersV3Request'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/InstanceWorkspaceSetMembersV3Request'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/InstanceWorkspaceSetMembersV3Request'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceMembersV3Response'
          description: Members replaced successfully
        '400':
          description: Invalid input
        '401':
          description: Authentication failed - missing or invalid API key
        '403':
          description: Permission denied - insufficient rights to modify
        '404':
          description: Workspace, user, or group not found
      security:
        - bearerAuth: []
components:
  schemas:
    InstanceWorkspaceSetMembersV3Request:
      type: object
      description: >-
        V3 API: Request serializer for bulk replacing workspace members
        (admin-only endpoint)
      properties:
        users:
          type: array
          items:
            $ref: '#/components/schemas/UserMember'
        groups:
          type: array
          items:
            $ref: '#/components/schemas/GroupMember'
    WorkspaceMembersV3Response:
      type: object
      description: V3 Response serializer for workspace members.
      properties:
        users:
          type: array
          items:
            $ref: '#/components/schemas/UserMember'
        groups:
          type: array
          items:
            $ref: '#/components/schemas/GroupMember'
      required:
        - groups
        - users
    UserMember:
      type: object
      properties:
        id:
          type: integer
        email:
          type: string
        role:
          type: string
      required:
        - email
        - id
        - role
    GroupMember:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        role:
          type: string
      required:
        - id
        - name
        - role
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer authentication header of the form `Bearer <token>`, where
        `<token>` is your auth token.

````