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

# Update a group

> > **Requires scope** `groups:write` · **Minimum role** editor

Renames a group or changes its description.

[Scopes and roles](https://docs.dueflow.co/api-reference/scopes)



## OpenAPI

````yaml /openapi.json patch /v1/groups/{groupId}
openapi: 3.1.0
info:
  title: Dueflow API
  version: 1.0.0
  description: >-
    Read and write your organization's Dueflow data. Authenticate with a
    personal access token or an organization service token as a bearer
    credential; cookies are ignored.
  termsOfService: https://dueflow.co/terms
  contact:
    name: Dueflow support
    email: support@dueflow.co
    url: https://docs.dueflow.co
servers:
  - url: https://api.dueflow.co
    description: Production
  - url: https://api.preview.dueflow.co
    description: Preview
security:
  - bearerAuth: []
paths:
  /v1/groups/{groupId}:
    patch:
      tags:
        - Groups
      summary: Update a group
      description: |-
        > **Requires scope** `groups:write` · **Minimum role** editor

        Renames a group or changes its description.

        [Scopes and roles](https://docs.dueflow.co/api-reference/scopes)
      operationId: patchGroupsByGroupId
      parameters:
        - name: groupId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 100
                description:
                  anyOf:
                    - type: string
                      maxLength: 500
                    - type: 'null'
              required: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                  description:
                    anyOf:
                      - type: string
                      - type: 'null'
                  amountDue:
                    anyOf:
                      - type: string
                      - type: 'null'
                  dueDate:
                    anyOf:
                      - type: string
                      - type: 'null'
                  isRecurring:
                    type: boolean
                  recurringInterval:
                    anyOf:
                      - type: string
                      - type: 'null'
                  memberCount:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  createdAt:
                    type: string
                    format: date-time
                  updatedAt:
                    type: string
                    format: date-time
                required:
                  - id
                  - name
                  - description
                  - amountDue
                  - dueDate
                  - isRecurring
                  - recurringInterval
                  - memberCount
                  - createdAt
                  - updatedAt
                additionalProperties: false
        '401':
          description: Missing, malformed, expired or revoked token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The token lacks a required scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such resource, or the token's organization can't see it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: >-
            The write conflicts with existing state, or an `Idempotency-Key` was
            reused with different parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited; see the `Retry-After` header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth:
            - groups:write
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            param:
              type: string
            requiredScopes:
              type: array
              items:
                type: string
            requestId:
              type: string
            docsUrl:
              type: string
          required:
            - code
            - message
            - requestId
            - docsUrl
          additionalProperties: false
      required:
        - error
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A Dueflow access token: `dfp_` (personal) or `dfs_` (service).
        Permissions are the token's scopes intersected with the role ceiling,
        re-evaluated per request.

````