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

# Update group

> Partially updates a group. At least one field must be provided.

Omitted fields remain unchanged. Set `description` or `pointOfContactEmail` to `null` to clear that field. Groups imported from an identity provider (IdP) may update their description or point of contact, but cannot be renamed.



## OpenAPI

````yaml /reference/manage-vanta.json patch /groups/{groupId}
openapi: 3.0.0
info:
  title: Manage Vanta
  version: 1.0.0
  description: >-
    The REST API lets customers query and mutate Vanta's data. Use this API to
    automate bulk actions, query data for custom workflows and dashboards, and
    bolster your security operations


    **Note for Vanta Gov (FedRAMP) customers:** Select `Vanta Gov (FedRAMP)`
    from the server dropdown to issue requests against
    `https://api.vanta-gov.com`. The OAuth token URL shown below defaults to the
    commercial host — replace it with `https://api.vanta-gov.com/oauth/token`.
  termsOfService: https://www.vanta.com/terms
  license:
    name: UNLICENSED
  contact:
    name: API Support
    url: https://help.vanta.com/
    email: support@vanta.com
servers:
  - url: https://api.vanta.com/v1
    description: Vanta (Commercial)
  - url: https://api.vanta-gov.com/v1
    description: Vanta Gov (FedRAMP)
security: []
paths:
  /groups/{groupId}:
    patch:
      tags:
        - Groups
      summary: Update group
      description: >-
        Partially updates a group. At least one field must be provided.


        Omitted fields remain unchanged. Set `description` or
        `pointOfContactEmail` to `null` to clear that field. Groups imported
        from an identity provider (IdP) may update their description or point of
        contact, but cannot be renamed.
      operationId: UpdateGroup
      parameters:
        - in: path
          name: groupId
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                pointOfContactEmail:
                  type: string
                  nullable: true
                  description: >-
                    Email of an active Vanta user with the Admin role in the
                    organization. Omit to preserve; pass null to clear.
                description:
                  type: string
                  nullable: true
                  description: New description. Omit to preserve; pass null to clear.
                name:
                  type: string
                  description: >-
                    New display name. Omit to preserve. Names are trimmed, must
                    be non-empty and unique, and cannot change for an
                    IdP-managed group.
              type: object
      responses:
        '200':
          description: Group updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
              examples:
                Example 1:
                  value:
                    id: 5f2c939a52855e725c8d5824
                    name: Default Group
                    creationDate: '2024-03-07T18:46:05.944Z'
                    description: null
                    source: Vanta
                    personnelCount: 0
                    pointOfContact:
                      displayName: Jane Doe
                      email: jane@example.com
      security:
        - bearerAuth: []
components:
  schemas:
    Group:
      properties:
        id:
          type: string
          description: The group's unique ID.
        name:
          type: string
          description: The group's name.
        creationDate:
          type: string
          format: date-time
          nullable: true
          description: The group's creation date.
        description:
          type: string
          nullable: true
          description: The group's description.
        source:
          type: string
          description: >-
            The source that created the group. Manually created groups are set
            to "Vanta"; groups imported from an external source use that
            source's display name.
        personnelCount:
          type: number
          format: double
          description: The number of personnel in the group.
        pointOfContact:
          properties:
            email:
              type: string
              description: The point of contact's email address.
            displayName:
              type: string
              description: The point of contact's display name.
          required:
            - email
            - displayName
          type: object
          nullable: true
          description: The group's point of contact.
      required:
        - id
        - name
        - creationDate
        - description
        - source
        - personnelCount
        - pointOfContact
      type: object
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

## Related topics

- [Add people to group](/api-reference/groups/add-people-to-group.md)
- [Remove people from group](/api-reference/groups/remove-people-from-group.md)
- [Create Trust Center update](/api-reference/trust-centers/create-trust-center-update.md)
- [Update resource metadata](/api-reference/integrations/update-resource-metadata-1.md)
- [Create group](/api-reference/groups/create-group.md)