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

# Update a Group

> Updates a Group's information.



## OpenAPI

````yaml /pt/openapi/v3-current/AM-identity.yaml patch /v1/groups/{id}
openapi: 3.0.1
info:
  contact: {}
  description: This is a swagger documentation for the Identity API
  termsOfService: http://swagger.io/terms/
  title: Identity API
  version: 1.0.0
servers:
  - url: //localhost:4001/
security: []
paths:
  /v1/groups/{id}:
    patch:
      tags:
        - Groups
      summary: Update a Group
      description: Updates a Group's information.
      parameters:
        - description: Group ID
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupUpdateInput'
        description: Group Update Input
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupFullResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pkg.HTTPError'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pkg.HTTPError'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pkg.HTTPError'
          description: Internal Server Error
      security:
        - BearerAuth: []
components:
  schemas:
    GroupUpdateInput:
      description: GroupUpdateInput payload
      example:
        contactEmail: updated@example.com
        displayName: Updated Group
        isEnabled: true
      properties:
        contactEmail:
          description: >-
            Group's contact email. Use a pointer to distinguish "not sent" (nil)
            from "clear it" (pointer to "").
          example: updated@example.com
          type: string
        displayName:
          description: Group's display name.
          example: Updated Group
          type: string
        isEnabled:
          description: Whether the group is enabled.
          example: true
          type: boolean
      type: object
    GroupFullResponse:
      description: GroupFullResponse payload
      example:
        createdAt: '2026-01-01T00:00:00.000Z'
        isTopGroup: false
        manager: admin
        contactEmail: admin@example.com
        isEnabled: true
        name: My Group
        id: my-group
        type: custom
        parentId: parent-group
        users:
          - user1
          - user2
        updatedAt: '2026-06-24T10:00:00.000Z'
      properties:
        contactEmail:
          example: admin@example.com
          type: string
        createdAt:
          example: '2026-01-01T00:00:00.000Z'
          type: string
        id:
          example: my-group
          type: string
        isEnabled:
          example: true
          type: boolean
        isTopGroup:
          example: false
          type: boolean
        manager:
          example: admin
          type: string
        name:
          example: My Group
          type: string
        parentId:
          example: parent-group
          type: string
        type:
          example: custom
          type: string
        updatedAt:
          example: '2026-06-24T10:00:00.000Z'
          type: string
        users:
          example:
            - user1
            - user2
          items:
            type: string
          type: array
      type: object
    pkg.HTTPError:
      properties:
        code:
          type: string
        entityType:
          type: string
        err:
          type: object
        message:
          type: string
        title:
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      description: 'Bearer authentication. Send Authorization: Bearer <token>.'
      in: header
      name: Authorization
      type: apiKey

````