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

# Update group

> Update an existing group with new name, description, or permissions.



## OpenAPI

````yaml /openapi/brms.json put /api/projects/{projectId}/groups/{groupId}
openapi: 3.0.3
info:
  title: GoRules BRMS
  version: local
servers: []
security: []
tags:
  - name: AI
    description: >-
      AI-powered assistant for interactive conversations and decision logic
      generation
  - name: Audit log
    description: Track and export organisation activity logs for compliance and monitoring
  - name: Branches
    description: >-
      Manage feature branches for collaborative decision development with
      commits and merging
  - name: Change requests
    description: Review and approve changes before merging or deploying to environments
  - name: Cloud
    description: Cloud-specific endpoints for organisation and client management
  - name: Decision
    description: Evaluate and simulate decision graphs with trace and performance data
  - name: Deployment workflows
    description: Manage deployment workflow runs and job approvals
  - name: Deployments
    description: Configure cloud storage providers for release deployments
  - name: Document
    description: Manage decision documents, versions, and file operations within projects
  - name: Environment
    description: >-
      Configure deployment environments with approval workflows and access
      tokens
  - name: Group
    description: Manage permission groups for project-level access control
  - name: Infrastructure
    description: Health check and infrastructure status endpoints
  - name: Integration
    description: Configure external integrations for HTTP requests and data sources
  - name: Invitation
    description: Manage organisation invitations for new members
  - name: Member
    description: Manage project membership and group assignments
  - name: Organisation
    description: Manage organisation settings, preferences, and licensing
  - name: Personal access token
    description: Create and manage personal access tokens for API authentication
  - name: Profile
    description: Manage current user profile settings
  - name: Project
    description: Create and manage projects with approval workflows
  - name: Release
    description: >-
      Package, version, and deploy decision documents. Learn more about
      [Releases](https://gorules.io/developers/brms/multi-environment)
  - name: Roles
    description: Define custom roles with permissions for organisation-wide access control
  - name: Security
    description: Manage project access tokens for API authentication
  - name: Templates
    description: Browse and apply project templates for quick onboarding
  - name: Test events
    description: Manage test events for decision evaluation and testing
  - name: User
    description: Manage organisation users, invitations, and service accounts
paths:
  /api/projects/{projectId}/groups/{groupId}:
    put:
      tags:
        - Group
      summary: Update group
      description: Update an existing group with new name, description, or permissions.
      operationId: updateGroup
      parameters:
        - schema:
            type: string
            format: uuid
          in: path
          name: groupId
          required: true
          description: ID of the group to update
        - schema:
            type: string
            format: uuid
          in: path
          name: projectId
          required: true
          description: ID of the project the group belongs to
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: New name for the group
                description:
                  type: string
                  description: New description for the group
                permissions:
                  type: array
                  items:
                    type: string
                    enum:
                      - owner
                      - documents
                      - releases
                      - releases:manage
                      - releases:deploy
                      - releases:delete
                      - integrations:manage
                      - documents:full
                      - documents:view-content
                      - documents:edit-content
                      - documents:edit-view
                      - branches
                      - branches:create
                      - branches:merge
                      - branches:delete
                      - project:manage
                      - environments
                      - environments:manage
                      - environments:delete
                  description: Updated list of permissions for the group
                filePermissions:
                  type: array
                  nullable: true
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                        nullable: true
                      effect:
                        type: string
                        enum:
                          - allow
                          - deny
                      actions:
                        type: array
                        nullable: true
                        items:
                          type: string
                          enum:
                            - visible
                            - modify
                            - write
                            - delete
                        default: []
                      patterns:
                        type: string
                        nullable: true
                    required:
                      - effect
                  default: []
                  description: Updated file-level permissions for the group
              required:
                - name
        required: true
      responses:
        '200':
          description: The updated group
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    description: Unique identifier of the group
                  name:
                    type: string
                    description: Name of the group
                  description:
                    type: string
                    description: Description of the group
                  projectId:
                    type: string
                    format: uuid
                    description: ID of the project this group belongs to
                  permissions:
                    type: array
                    nullable: true
                    items:
                      type: string
                      enum:
                        - owner
                        - documents
                        - releases
                        - releases:manage
                        - releases:deploy
                        - releases:delete
                        - integrations:manage
                        - documents:full
                        - documents:view-content
                        - documents:edit-content
                        - documents:edit-view
                        - branches
                        - branches:create
                        - branches:merge
                        - branches:delete
                        - project:manage
                        - environments
                        - environments:manage
                        - environments:delete
                    description: List of permissions granted to this group
                  filePermissions:
                    type: array
                    nullable: true
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          nullable: true
                          description: Unique identifier of the file permission
                        effect:
                          type: string
                          enum:
                            - allow
                            - deny
                          description: Whether this permission allows or denies the actions
                        actions:
                          type: array
                          nullable: true
                          items:
                            type: string
                            enum:
                              - visible
                              - modify
                              - write
                              - delete
                          default: []
                          description: List of actions this permission applies to
                        patterns:
                          type: string
                          nullable: true
                          description: Glob pattern to match file paths
                      required:
                        - effect
                        - actions
                    description: File-level permissions for this group
                  roleId:
                    type: string
                    format: uuid
                    description: ID of the access profile managing this group
                  role:
                    type: object
                    nullable: true
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: Unique identifier of the role
                      name:
                        type: string
                        description: Name of the role
                      description:
                        type: string
                        description: Description of the role
                    required:
                      - id
                      - name
                    description: Access profile that manages this group
                required:
                  - id
                  - name
                  - projectId
                  - permissions
                description: The updated group
      security:
        - personalAccessToken: []
        - internalAuth: []
components:
  securitySchemes:
    personalAccessToken:
      type: http
      scheme: bearer
      description: Personal access token is obtained through your profile
    internalAuth:
      type: http
      scheme: internal
      description: Cannot be used directly

````