Skip to main content
PATCH
Update a group
Dashboard session only. API keys cannot call this operation.

Authorizations

Authorization
string
header
required

ID token of a signed-in dashboard user. Operations that API keys cannot call use it.

Path Parameters

groupId
integer<uint64>
required

Numeric id (groupId). A non-numeric id is a 400 data-failed-validation; an unknown id or one of another partner is a 404. Unsigned 64-bit integer. May exceed 2^53; parse with a BigInt-safe JSON parser in JavaScript.

Required range: 0 <= x <= 18446744073709552000

Body

application/json

Update a group.

name
string

1-80 characters.

Maximum string length: 80
description
string | null

Up to 500 characters.

permissions
string[]

Replaced whole.

Permission.

memberIds
integer<uint64>[]

Replaced whole.

Unsigned 64-bit integer. May exceed 2^53; parse with a BigInt-safe JSON parser in JavaScript.

Required range: 0 <= x <= 18446744073709552000

Response

Success.

Single-object envelope around Group.

data
object
required

A group of members with permissions.