Update a group
PATCH/v1/directory/groups/{group_id}
Renames a group or changes its description. Send only what changes.
Permission: identity:UpdateGroup. Changes need a sign-in that used a second factor.
Path parameters
| Parameter | Type | Description |
|---|---|---|
group_id |
string | The group's ID. |
Body
| Field | Type | Description |
|---|---|---|
name |
string | Up to 128 characters. |
description |
string | Up to 1,000 characters. |
Returns
200 OK
{
"id": "3c5e8a90-1d2b-4e6f-8a7c-9b0d1e2f3a4b",
"name": "Engineering",
"description": "Engineering and design",
"members": [
"8f0c2c1e-6b1a-4f3e-9a51-0c3d2f7e9b10"
],
"created_at": "2026-11-19T09:00:00Z",
"updated_at": "2026-11-19T09:00:00Z"
}Errors
Besides the errors every call can return:
| Status | When |
|---|---|
404 |
No such resource in your organization. |
409 |
Another group has that name. |
Example
curl -X PATCH https://<company>.yotta.bot/v1/directory/groups/3c5e8a90-1d2b-4e6f-8a7c-9b0d1e2f3a4b \
-H "Authorization: Bearer $YOTTABOT_TOKEN" \
-H "Content-Type: application/json" \
-d '{"description": "Engineering and design"}'With yottactl
yottactl org groups update 3c5e8a90-1d2b-4e6f-8a7c-9b0d1e2f3a4b \
--set description=Engineering and design