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

# Update a group

`PATCH /v1/groups/{id}`

## Request

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

Changes a group's name, your `externalId` for it or its company description in `context`. Null clears externalId. Null clears context too, so the workspace profile applies again. New mentions use the new context right away, and older ones are not scored again. You can rename the default group, but it takes no description, because it is the workspace itself and uses the company profile.

## Path parameters

- `id` string, required: The group's id (grp_...).

## Request body

- object: Fields you leave out stay as they are.
  - `name` string: The group's name, such as a client, campaign or product. Must be unique in the workspace.
  - `externalId` string, nullable: Sets a new external id. Null removes it.
  - `context` string, nullable: Sets a new company description for the group. Null removes it, and the workspace profile applies again. New mentions use it right away, and older ones are not scored again. The default group cannot have one (400 default_group_context), because it is the workspace itself and uses the profile.

## Response `200`

The group after the change

- Group: The keyword's group.
  - `id` string, required: The group's id (grp_...).
  - `name` string, required: Name of the group.
  - `externalId` string, nullable, required: An id from your own system, or null.
  - `isDefault` boolean, required: True for the workspace's default group. New keywords go there when you don't name a group.
  - `context` string, nullable, required: A company description just for this group, which the classifier reads. Null means the workspace profile is used.
  - `stats` object, required: Counted from the group's keywords.
    - `keywords` integer, required: Number of keywords in the group, muted or not.
    - `active` integer, required: Number of unmuted keywords in the group.
  - `createdAt` string, required: UTC time in ISO 8601.
  - `updatedAt` string, required: UTC time in ISO 8601.

## Other responses

- `400`: The default group cannot have a company description (default_group_context)
- `401`: The API key is missing or not valid
- `404`: This workspace has no group with this id
- `409`: This name or externalId is already used by a group (duplicate_group)

---

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