update_group

Purpose

Renames a group or replaces the permissions it grants. code is immutable, so a rename never breaks a reference.

Who is in the group is sync_group_members, not this — a rename is cosmetic, while changing the permission set silently re-scopes everyone already in the group.

Permissions replace, they do not merge

Sending permissions sets the group's permissions to exactly that list. Omit the key entirely to leave the existing set untouched while changing only the name.

Growth-tier capability. On a lower tier this returns TEAM_TIER_REQUIRED and changes nothing.

Required ability

group:update

Input schema

{
  "type": "object",
  "properties": {
    "group_id": {
      "type": "string",
      "description": "UUID of the group to update."
    },
    "name": {
      "type": "string",
      "description": "New group name. Omit to keep the current one."
    },
    "permissions": {
      "type": "array",
      "description": "Complete replacement permission set. Omit to leave permissions untouched."
    }
  },
  "required": ["group_id"]
}

Output shape

{
  "data": {
    "id": "1f68d92a-04c5-4e83-97b1-3d6a05e2f847",
    "team_id": "a83f0d51-4c92-4b7e-8615-2fd9e70a3c86",
    "code": "billing-team",
    "name": "Billing & Finance",
    "permissions": ["project-subscription:view-any", "payment:view-any"]
  }
}

Emits group.updated.

Example prompts

"Let the billing group read payments too."

"Rename the billing group to Billing & Finance."

Failure modes

AUTHENTICATION_REQUIRED — no authenticated user on the request.
TOKEN_MISSING_ABILITY — token lacks group:update.
TEAM_TIER_REQUIRED — the caller's platform tier does not include Teams.
RESOURCE_NOT_FOUND — no such group in any team the caller belongs to.
VALIDATION_FAILED — an unknown permission string.

sync_group_members — same ability, different concern.
create_group
delete_group
Groups API