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

> ## Agent Instructions
> Internal links on these pages omit the .md extension. Append .md to a docs page URL, or send an Accept: text/markdown header, to get that page as markdown.

# Update workspace group

> <Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Renames a group, changes its description, or changes the role it grants. Send only the fields you want to change.

Set `role` to `null` to clear it, so the group grants no role. Leave `role` out to keep it. A new role on a custom group applies to every member right away.

A group whose `source` is `idp` gets its name and members from your identity provider, so they can't be changed here. Its role and description can still change. An `idp` group grants its role only while the workspace uses identity-provider groups. Otherwise its role is stored but grants nothing. You can't make a change that removes your own admin access.

The response's `unresolved_count` is always `0`. Read the real count from [List workspace groups](/api-reference/list-workspace-groups).

Groups need the Business plan or higher. Below it, this returns a `402`.

This is limited to 60 requests per minute, shared with the other endpoints that change groups or their members. A signed-in session has its own limit, and every personal access token for the workspace shares one. Some workspaces have a different limit.

<Note>Call this as an owner or admin of the workspace, with a personal access token for that workspace sent as a Bearer token, or from a signed-in session. A read-only token is refused, and workspace API keys aren't accepted.</Note>



## OpenAPI

````yaml /developers/references/app-management/app-management-openapi.json put /api/workspace/groups/{group_id}
openapi: 3.1.0
info:
  title: Base44 App Management API
  version: 1.0.0
servers:
  - url: https://app.base44.com
security:
  - PersonalAccessTokenAuth: []
paths:
  /api/workspace/groups/{group_id}:
    put:
      summary: Update workspace group
      description: >-
        <Info>This API is in beta. Endpoints, fields, and behavior may still
        change, so avoid depending on it in production.</Info>


        Renames a group, changes its description, or changes the role it grants.
        Send only the fields you want to change.


        Set `role` to `null` to clear it, so the group grants no role. Leave
        `role` out to keep it. A new role on a custom group applies to every
        member right away.


        A group whose `source` is `idp` gets its name and members from your
        identity provider, so they can't be changed here. Its role and
        description can still change. An `idp` group grants its role only while
        the workspace uses identity-provider groups. Otherwise its role is
        stored but grants nothing. You can't make a change that removes your own
        admin access.


        The response's `unresolved_count` is always `0`. Read the real count
        from [List workspace groups](/api-reference/list-workspace-groups).


        Groups need the Business plan or higher. Below it, this returns a `402`.


        This is limited to 60 requests per minute, shared with the other
        endpoints that change groups or their members. A signed-in session has
        its own limit, and every personal access token for the workspace shares
        one. Some workspaces have a different limit.


        <Note>Call this as an owner or admin of the workspace, with a personal
        access token for that workspace sent as a Bearer token, or from a
        signed-in session. A read-only token is refused, and workspace API keys
        aren't accepted.</Note>
      operationId: update_group_api_workspace_groups__group_id__put
      parameters:
        - name: group_id
          in: path
          required: true
          schema:
            type: string
            description: >-
              ID of the group to update. Get it from `id` in [List workspace
              groups](/api-reference/list-workspace-groups).
            title: Group Id
          description: >-
            ID of the group to update. Get it from `id` in [List workspace
            groups](/api-reference/list-workspace-groups).
          example: 68b4e1d2c9a7f3001e2d4b61
        - name: workspaceId
          in: query
          required: true
          schema:
            type: string
            minLength: 1
            description: >-
              ID of the workspace. With a personal access token, use the token's
              workspace. Get it from `organization_id` in [Get
              app](/api-reference/get-app).
            title: Workspaceid
          description: >-
            ID of the workspace. With a personal access token, use the token's
            workspace. Get it from `organization_id` in [Get
            app](/api-reference/get-app).
          example: 67e0b12c4d8a3f005b21c9e4
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateGroupRequest'
      responses:
        '200':
          description: The updated group.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceGroupSummary'
        '400':
          description: >-
            Another custom group already has this name, you tried to rename an
            identity-provider group, or the change would remove your own admin
            access.
        '401':
          description: Missing or invalid credentials.
        '402':
          description: The workspace's plan doesn't include groups.
        '403':
          description: >-
            You aren't an owner or admin of the workspace, your token is for a
            different workspace or is read-only, or your credential can't be
            used on this endpoint.
        '404':
          description: Group not found in this workspace.
        '409':
          description: Your workspace requires an unlocked SSO session.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Rate limit exceeded.
components:
  schemas:
    UpdateGroupRequest:
      properties:
        name:
          anyOf:
            - type: string
              maxLength: 100
              minLength: 1
            - type: 'null'
          title: Name
          description: >-
            New name, up to 100 characters. An identity-provider group's name
            can't change.
          example: Brand design
        description:
          anyOf:
            - type: string
              maxLength: 500
            - type: 'null'
          title: Description
          description: New description, up to 500 characters. An empty string clears it.
          example: Brand and marketing designers
        role:
          anyOf:
            - type: string
            - type: 'null'
          title: Role
          description: >-
            New role: `admin`, `editor`, `viewer`, or `no_access`. Send `null`
            to clear it so the group grants no role, or leave it out to keep it.
          example: viewer
      type: object
      title: UpdateGroupRequest
    WorkspaceGroupSummary:
      properties:
        id:
          type: string
          title: Id
          description: ID of the group.
          example: 68b4e1d2c9a7f3001e2d4b61
        name:
          type: string
          title: Name
          description: Name of the group.
          example: Design team
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Short description of the group, or `null` when it has none.
          example: Product designers
        source:
          type: string
          title: Source
          description: >-
            `custom` for a group created in Base44, or `idp` for one your
            identity provider sends through SCIM. An `idp` group's name and
            members come from the identity provider.
          example: custom
        role:
          anyOf:
            - type: string
            - type: 'null'
          title: Role
          description: >-
            Role every member gets from the group: `admin`, `editor`, `viewer`,
            or `no_access`. `null` when the group grants no role.
          example: editor
        member_count:
          type: integer
          title: Member Count
          description: Number of members.
          example: 12
        unresolved_count:
          type: integer
          title: Unresolved Count
          description: >-
            Members your identity provider sent who don't have a Base44 account
            in the workspace yet. Always `0` for a `custom` group.
          default: 0
          example: 0
      type: object
      required:
        - id
        - name
        - source
        - member_count
      title: WorkspaceGroupSummary
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    PersonalAccessTokenAuth:
      type: http
      scheme: bearer
      description: 'Personal access token, sent as `Authorization: Bearer <token>`.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.