---
title: "Update a group"
url: "https://earlyaccess.developers.bynder.com/apis/groups-1/versions/8b5e3751-b1f6-4df8-9f5d-f494f76062f0/operations/updateGroup"
---

> Full API specification: https://earlyaccess.developers.bynder.com/apis/groups-1/versions/8b5e3751-b1f6-4df8-9f5d-f494f76062f0.md

# Update a group

`PATCH` `/api/1/groups/{groupId}`

Operation ID: `updateGroup`

Updates the name and/or description of an existing group. At least one field must be provided. Only the fields included in the request body are updated (partial update semantics). Requires the **GROUPMANAGEMENT** security role.

## Path parameters

- `groupId` (string, uuid, required) - ID of the group to update (hyphens optional).

## Request body (required)

Content types: `application/json`

## Responses

- `200` - Group updated successfully.
- `401` - Missing or invalid authentication. The response body is empty.
- `403` - The authenticated user does not have the **GROUPMANAGEMENT** security role.
- `404` - Group not found.
- `409` - A group with the requested name already exists.
- `422` - Validation error (e.g. empty request body, malformed group ID, or `name` is not a string).

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Groups
  version: 1.0.0
servers:
  - url: https://{your-bynder-domain}/
paths:
  /api/1/groups/{groupId}:
    patch:
      description: >
        Updates the name and/or description of an existing group.


        At least one field must be provided. Only the fields included in the
        request body are updated

        (partial update semantics).


        Requires the **GROUPMANAGEMENT** security role.
      operationId: updateGroup
      parameters:
        - description: ID of the group to update (hyphens optional).
          in: path
          name: groupId
          required: true
          schema:
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              minProperties: 1
              properties:
                description:
                  description: New description for the group. Pass `null` to clear it.
                  type:
                    - string
                    - "null"
                name:
                  description: New name for the group. Must be unique within the account.
                  type: string
              type: object
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Group"
          description: Group updated successfully.
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "409":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
          description: A group with the requested name already exists.
        "422":
          description: Validation error (e.g. empty request body, malformed group ID, or
            `name` is not a string).
      security:
        - permanentToken:
            - GROUPMANAGEMENT
        - OAuth2:
            - GROUPMANAGEMENT
      summary: Update a group
      tags:
        - Groups (Preferred)
security:
  - permanentToken:
      - GROUPMANAGEMENT
  - OAuth2:
      - GROUPMANAGEMENT
components:
  schemas:
    Group:
      example:
        description: Everyone in the marketing department
        id: 0397e4bd-33fe-4b8f-a51d-4c2f1d9b6c1a
        name: Marketing
        user_count: 12
      properties:
        description:
          type:
            - string
            - "null"
        id:
          format: uuid
          type: string
        name:
          type: string
        user_count:
          description: Number of members in the group.
          type: integer
      type: object
    ErrorResponse:
      properties:
        detail:
          properties:
            error:
              description: Human-readable description of the error.
              type: string
          type: object
      type: object
    NotFoundResponse:
      properties:
        detail:
          example: Not Found
          type: string
      type: object
  responses:
    Unauthorized:
      description: Missing or invalid authentication. The response body is empty.
    Forbidden:
      description: The authenticated user does not have the **GROUPMANAGEMENT**
        security role.
    NotFound:
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/NotFoundResponse"
      description: Group not found.
  securitySchemes:
    permanentToken:
      in: header
      name: Authorization
      type: apiKey
    OAuth2:
      flows:
        authorizationCode:
          authorizationUrl: https://{your-auth-url}
          scopes:
            GROUPMANAGEMENT: Grants permission to manage groups`
          tokenUrl: https://{your-bynder-domain}/v6/authentication/oauth2/token
        clientCredentials:
          scopes:
            GROUPMANAGEMENT: Grants permission to manage groups
          tokenUrl: https://{your-bynder-domain}/v6/authentication/oauth2/token
      type: oauth2
```