---
title: How to Update a Group
url: https://docs.vultr.com/platform/iam/groups/how-to-update-a-group
description: Update an existing IAM group in your Vultr organization. Modify the group name or description through the Vultr API or Console to reflect current team roles.
publish_date: 2026-03-24T19:52:20.712891Z
last_updated: 2026-06-01T20:40:17.167642Z
---

Updating a group allows you to change its display name or description. This is useful when a group's purpose evolves or when you need to correct naming conventions across your organization.

> [!NOTE]
> You must be the organization's root user or have `iam.group.*` permissions assigned to perform this action.

Follow this guide to update a group using the Vultr Console, the Vultr API, or Terraform.

=== "Vultr Console"

    1. Log in to the [Vultr Console](https://console.vultr.com).
    1. Click the organization name in the top navigation bar.
    1. Click **Manage Organization**.
    1. Click the **Groups** tab.
    1. Click the name of the group you want to update.
    1. Click the **Edit** icon next to the group details.
    1. In the **Edit Group** panel, update the **Group Name** and **Group Description**.
    1. Click **Save Changes**.

        The group details are updated.

=== "Vultr API"

    1. Send a `GET` request to the [**List Groups** endpoint](https://www.vultr.com/api/#tag/iam/operation/list-iam-groups) to retrieve all groups in your organization.

        ```console
        $ curl "https://api.vultr.com/v2/groups" \
            -X GET \
            -H "Authorization: Bearer ${VULTR_API_KEY}"
        ```

        Note the `id` of the group you want to update.

    1. Send a `GET` request to the [**Read Group** endpoint](https://www.vultr.com/api/#tag/iam/operation/get-iam-group) to retrieve the current group details. Replace `{group-id}` with the id you retrieved in the previous step.

        ```console
        $ curl "https://api.vultr.com/v2/groups/{group-id}" \
            -X GET \
            -H "Authorization: Bearer ${VULTR_API_KEY}"
        ```

    1. Send a `PUT` request to the [**Update Group** endpoint](https://www.vultr.com/api/#tag/iam/operation/update-iam-group) to update the group. Replace `NEW-GROUP-NAME` and `NEW-GROUP-DESCRIPTION` with the updated values.

        ```console
        $ curl "https://api.vultr.com/v2/groups/{group-id}" \
            -X PUT \
            -H "Authorization: Bearer ${VULTR_API_KEY}" \
            -H "Content-Type: application/json" \
            -d '{
                "display_name": "NEW-GROUP-NAME",
                "description": "NEW-GROUP-DESCRIPTION"
            }'
        ```

        The response confirms the group has been updated.

    1. Send a `GET` request to the [**Read Group** endpoint](https://www.vultr.com/api/#tag/iam/operation/get-iam-group) to retrieve the updated details.

        ```console
        $ curl "https://api.vultr.com/v2/groups/{group-id}" \
            -X GET \
            -H "Authorization: Bearer ${VULTR_API_KEY}"
        ```

        Verify that the `display_name` and `description` fields reflect the new values.

=== "Terraform"

    1. Ensure the [Vultr Terraform provider](https://registry.terraform.io/providers/vultr/vultr/latest/docs) is configured in your Terraform project.

    1. Open the group resource configuration and modify the `name` or `description` field.

        ```console
        $ nano groups.tf
        ```

    1. Apply the changes.

        ```console
        $ terraform apply
        ```

        Verify that the output shows `vultr_organization_group.my_group: Modifications complete`.