Skip to main content
PATCH
Update

Authorizations

Authorization
string
header
required

An API key from Settings, API Keys. A caller on this machine needs none.

Path Parameters

id
string
required
Pattern: ^[a-fA-F0-9]{24}$
Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

Body

application/json
name
string
Required string length: 1 - 200
color
string
Maximum string length: 32
icon
string
Maximum string length: 64
description
string
Maximum string length: 1000
permissions
object[]
Maximum array length: 200
pools
string[] | null
Maximum array length: 100
Pattern: ^[a-fA-F0-9]{24}$
hidden_pools
string[] | null
Maximum array length: 100
Pattern: ^[a-fA-F0-9]{24}$
submit
object | null

Response

The updated group

id
string
required
Pattern: ^[a-fA-F0-9]{24}$
Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

name
string
required
color
string
default:""
required
icon
string
default:""
required
description
string
default:""
required
permissions
object[]
required

Feature permissions granted to members

pools
string[] | null
required
Pattern: ^[a-fA-F0-9]{24}$
hidden_pools
string[] | null
required
Pattern: ^[a-fA-F0-9]{24}$
submit
object | null
required