---
title: "Change a group"
method: PATCH
path: "/groups/{id}"
tags: ["Mailbox access"]
---

# Change a group

`PATCH /groups/{id}`

## Request

- Base URL: `https://api.primitive.dev/v1`
- URL: `https://api.primitive.dev/v1/groups/{id}`
- Auth: HTTP bearer

Renames a group or replaces its members. With an org-wide API key or the person's own Primitive CLI only role-free groups are changed. As on creation, a role naming a member's personal mailbox is never given through the group to anyone else (`personal_mailbox_member_only`).

## Path parameters

- `id` string, uuid, required

## Request body

- UpdateGroupRequest
  - `name` string
  - `description` string, nullable
  - `role` string, nullable
  - `members` string[]

## Response `200`

Change a group

- object
  - `success` true, required
  - `data` UpdateGroupResult, required
    - `id` string, required
    - `name` string, required
    - `description` string, nullable, required
    - `role_id` string, nullable, required
    - `members` string[], required

## Other responses

- `400`: Invalid request parameters
- `401`: Invalid or missing API key
- `403`: Authenticated caller lacks permission for the operation
- `404`: feature_disabled: the feature is not enabled for the organization; or not_found: the item the path names does not exist.
- `409`: conflict: the item changed while you edited it, or a member was removed and added back. Look again, then retry.
- `429`: Rate limit exceeded. The `ratelimit-*` headers describe the limiter that rejected this request, with its own limit and window, not the API budget that successful responses report. A limiter that reports only a wait sends `Retry-After` alone.

---

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