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

# Update an access group

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

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

## 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.
- `410`

---

[API](https://skmtc.net/vercel/apis/api.md) · [All operations](https://skmtc.net/vercel/apis/api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vercel/api/versions/61d1ba3f6dac/schema)