---
title: "Update an access group"
method: POST
path: "/v1/access-groups/{idOrName}"
tags: ["access-groups"]
---

# Update an access group

`POST /v1/access-groups/{idOrName}`

## Request

- Base URL: `https://api.vercel.com`
- URL: `https://api.vercel.com/v1/access-groups/{idOrName}`
- Auth: HTTP bearer

Allows to update an access group metadata

## Path parameters

- `idOrName` string, required

## Query parameters

- `teamId` string
- `slug` string

## Request body

- object
  - `name` string: The name of the access group
  - `projects` object[]
    - `projectId` string, required: The ID of the project.
    - `role` 'ADMIN' | 'PROJECT_VIEWER' | 'PROJECT_DEVELOPER' | 'null', nullable, required: The project role that will be added to this Access Group. "null" will remove this project level role.
  - `membersToAdd` string[]: List of members to add to the access group.
  - `membersToRemove` string[]: List of members to remove from the access group.

## Response `200`

- object
  - `accessGroupId` string, required: ID of the access group.
  - `createdAt` string, required: Timestamp in milliseconds when the access group was created.
  - `entitlements` string[], required
  - `membersCount` number, required: Number of members in the access group.
  - `name` string, required: The name of this access group.
  - `projectsCount` number, required: Number of projects in the access group.
  - `teamId` string, required: ID of the team that this access group belongs to.
  - `teamPermissions` string[]: Permissions that the team has in the access group.
  - `teamRoles` string[]: Roles that the team has in the access group.
  - `updatedAt` string, required: Timestamp in milliseconds when the access group was last updated.

## Other responses

- `400`: One of the provided values in the request body is invalid. One of the provided values in the request query is invalid.
- `401`: The request is not authorized.
- `403`: You do not have permission to access this resource.
- `404`
- `410`

## Changes

- **2026-09-30** `099fbe1f521c`: 1 info
  - added the non-success response with the status `404`
- **2026-07-21** `2ae10ee9d21c`: 1 info
  - added the non-success response with the status `410`
- **2026-01-22** `c12186034433`: 1 breaking
  - request body became required
- **2025-10-09** `50caddad4ae7`: 2 info
  - removed the non-success response with the status `404`
  - the response property `entitlements` became required for the status `200`
- **2025-03-19** `37b482c58c92`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/vercel/apis/vercel-api/changes/v1/access-groups/:idOrName/post.md)

---

[API](https://skmtc.dev/vercel/apis/vercel-api.md) - [All operations](https://skmtc.dev/vercel/apis/vercel-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vercel/apis/vercel-api/revisions/60686c0e1f6a?raw)