Skip to main content
PATCH
Update a permission group
Changes a group’s name, description, or membership. Send only the fields you are changing.

Request body

users is a replacement, not an addition. Sending {"users": [7]} to a group of twelve leaves one person in it, and the other eleven lose every grant that reached them through the group. To add or remove a few people without touching the rest, use Add Members and Remove Members.

Rename a group

Renaming changes nothing about access. Grants point at the group’s id.

Replace a membership

Useful when your own system is the source of truth for a team and you are syncing it across, rather than tracking individual joins and leaves.
Anybody dropped from the list loses the group’s grants immediately, and anybody added gains them — no permission call either way.

Response

200, with the updated permission group object.

Errors

PUT is also available and replaces every writable field at once. PATCH is what you usually want.

Authorizations

x-api-key
string
header
required

API Key authentication. Format: 'x-api-key: api_key'

Path Parameters

id
string<uuid>
required

The permission group's id.

Body

name
string
Maximum string length: 150
description
string | null
users
integer[]

Users (Expandable)

Response

200 - application/json
id
string<uuid>
required
read-only
name
string
required
Maximum string length: 150
all_group
boolean
required
read-only
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
users
integer[]
required

Users (Expandable)

description
string | null