---
title: "Update a recipient group (PATCH alias)"
method: PATCH
path: "/api/v1/recipient-groups/{group}"
tags: ["Recipient groups"]
---

# Update a recipient group (PATCH alias)

`PATCH /api/v1/recipient-groups/{group}`

## Request

- Base URL: `https://wardenpoint.com` (the document declares no server; this is the origin it was published from)
- URL: `https://wardenpoint.com/api/v1/recipient-groups/{group}`
- Auth: API key in header `X-API-Key`

Identical to PUT on the same path. `name` stays required either way, and `recipients` stays **authoritative whenever you send it** — the list you send becomes the membership, and anyone missing from it leaves the group. The verb does not make it additive. Omit the field to leave membership alone. `description`, by contrast, really is partial: omitted keeps it, explicit null erases it.

## Path parameters

- `group` string, uuid, required

## Request body

- RecipientGroupWriteRequest
  - `name` string, required: Display name.
  - `description` string, nullable: Free text for people, never used to route anything. Omitting the field on an update leaves the stored text alone; sending an explicit null erases it. This is the one field here that behaves that way — `recipients` is authoritative, not sparse.
  - `recipients` string[], nullable: Full member list, by recipient UUID. Omit to leave membership untouched, send [] to empty the group; anyone missing from a non-empty list is removed. UUIDs belonging to another company are silently ignored.

## Response `200`

Updated group.

- object
  - `data` RecipientGroup: A named set of recipients. `POST /notifications/send-to-group` takes the UUID of one.
    - `uuid` string, uuid: Stable identifier — every group endpoint takes this.
    - `name` string: Display name.
    - `description` string, nullable: Free-form note about what the group is for.
    - `is_active` boolean
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `recipients_count` integer: Number of members. A zero here means alerts sent to this group reach nobody.
    - `recipients` object[]: Members. Present only on single-group responses, not in the listing.
      - `uuid` string, uuid
      - `name` string
      - `is_active` boolean

## Other responses

- `401`: API key missing, invalid, revoked or expired.
- `403`: API key lacks config.write, or the group belongs to another company.
- `404`: No group with this UUID.
- `422`: Validation failed.

---

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