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

# Update a group



## OpenAPI

````yaml put /groups/{groupId}
openapi: 3.0.1
info:
  title: Elementum API
  description: ''
  contact:
    email: apiteam@elementum.io
  version: 0.0.1
servers:
  - url: /v1
security: []
tags:
  - name: Access Token
    description: Manage access tokens using OAuth 2.0 standards
  - name: Agents
    description: Manage AI agents
  - name: Apps
    description: Compose and manage apps
  - name: Attachments
    description: Manage the attachments of a record
  - name: Automations
    description: Manage automations
  - name: Comments
    description: Manage the conversation of a record
  - name: Flows
    description: Manage flows
  - name: Groups
    description: Manage groups and group membership
  - name: Domains
    description: Manage organization domains
  - name: Records
    description: Manage your records
  - name: Related-items
    description: Manage the related items of a record
  - name: Search Tables
    description: Manage search tables (snowflake and linked)
  - name: Skills
    description: Manage agent skills
  - name: Tables
    description: 'Manage tables: schemas, fields, joins, and join mappings'
  - name: Users
    description: Manage users in your organization
  - name: Views
    description: Manage app views
  - name: Watchers
    description: Manage the watchers of a record
externalDocs:
  description: Find out more about Elementum
  url: https://www.elementum.com/
paths:
  /groups/{groupId}:
    put:
      tags:
        - Groups
      summary: Update a group
      operationId: updateGroup
      parameters:
        - $ref: '#/components/parameters/groupId'
      requestBody:
        description: The group fields to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupRequest'
        required: true
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
      security:
        - ClientCredentials: []
components:
  parameters:
    groupId:
      name: groupId
      in: path
      description: The group ID (UUID)
      required: true
      schema:
        type: string
        format: uuid
  schemas:
    GroupRequest:
      type: object
      properties:
        assignable:
          type: boolean
          description: Whether the group can be assigned to records
        approver:
          type: boolean
          description: Whether the group can act as an approver
        watchable:
          type: boolean
          description: Whether the group can be used as a watcher
        dynamic:
          type: boolean
          description: Whether the group derives membership from email domains
        hidden:
          type: boolean
          description: Whether the group is hidden
        tags:
          type: array
          description: Group tags
          items:
            type: string
        dataAccess:
          type: boolean
          description: Whether the group grants data access
        name:
          type: string
          description: The group name
        userIds:
          type: array
          description: Member user IDs; non-dynamic groups only
          items:
            type: string
            format: uuid
        domains:
          type: array
          description: Email domains for auto-assignment; dynamic groups only
          items:
            type: string
        mentionable:
          type: boolean
          description: Whether the group can be mentioned
      example:
        dataAccess: false
        userIds:
          - 550e8400-e29b-41d4-a716-446655440000
        name: Engineering
        assignable: true
        watchable: true
        approver: false
        mentionable: true
        dynamic: false
    Group:
      type: object
      properties:
        name:
          type: string
          description: The group name
        id:
          type: string
          description: The group ID
          format: uuid
        assignable:
          type: boolean
          description: Whether the group can be assigned to records
        watchable:
          type: boolean
          description: Whether the group can be used as a watcher
        mentionable:
          type: boolean
          description: Whether the group can be mentioned
        domains:
          type: array
          description: Email auto-assignment domains (dynamic groups only)
          items:
            $ref: '#/components/schemas/GroupDomain'
        managed:
          type: boolean
          description: Whether the group is system-managed
        dynamic:
          type: boolean
          description: Whether the group is dynamic
      example:
        mentionable: true
        watchable: true
        id: 550e8400-e29b-41d4-a716-446655440001
        dynamic: false
        assignable: true
        managed: false
        name: Engineering
    GroupDomain:
      type: object
      properties:
        domain:
          type: string
          description: The email domain
        id:
          type: string
          description: The auto-assignment rule ID
          format: uuid
      example:
        domain: example.com
        id: 550e8400-e29b-41d4-a716-446655440000
  responses:
    '400':
      description: Bad Request
    '401':
      description: Unauthorized
    '403':
      description: Forbidden
    '404':
      description: Not Found
    '422':
      description: Unprocessable Entity
    '429':
      description: Too Many Requests
    '500':
      description: Internal Server Error
  securitySchemes:
    ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: /oauth/token
          scopes: {}

````

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