---
title: "Update an unsubscribe group"
method: PATCH
path: "/v1/unsubscribe-groups/{id}"
tags: ["Unsubscribe Groups"]
---

# Update an unsubscribe group

`PATCH /v1/unsubscribe-groups/{id}`

## Request

- Base URL: `https://api.samva.dev`
- URL: `https://api.samva.dev/v1/unsubscribe-groups/{id}`
- Auth: API key in header `x-api-key`

Updates the name or description of an unsubscribe group.

## Path parameters

- `id` string, required

## Request body

- object
  - `name` string, nullable
  - `description` string, nullable

## Response `200`

Success

- object
  - `id` string, required
  - `organizationId` string, required
  - `name` string, required
  - `description` string, nullable, required
  - `isDefault` boolean, required
  - `memberCount` integer, required
  - `createdAt` string, required
  - `updatedAt` string, required

## Other responses

- `401`: UnauthorizedError
- `403`: ForbiddenError
- `404`: ResourceNotFoundError
- `422`: ValidationError
- `500`: InternalError
- `504`: GatewayTimeoutError

---

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