Skip to main content
PATCH
Update a usage group set

Authorizations

Authorization
string
header
required

Organization API key (sl_…).

Headers

If-Match
string | null
x-tenant-id
string
required

The organization ID the request is scoped to.

Path Parameters

usage_group_set_id
string
required

Body

application/json
name
string | null
Maximum string length: 199
order
integer | null
Required range: x >= 0
team_id
string<uuid> | null
public
boolean | null
version
integer | null

Set to the current version + 1 to snapshot the current groups as a new version. Any other value is rejected; omit it to leave versions untouched.

Required range: x >= 1

Response

Successful Response

name
string
required

Name of the usage group set. Must be less than 200 characters.

Maximum string length: 199
order
integer
required

Display order; lower values appear first.

Required range: x >= 0
id
string
required

The unique identifier of the usage group set.

etag
string
required

Opaque strong ETag for optimistic concurrency.

version
integer
required

Number of committed versions (snapshots). Increment it by one in a PATCH to snapshot the current groups as a new version; ordinary group edits mutate the current version in place and leave it unchanged.

team_id
string<uuid> | null
public
boolean
default:false

Whether the set is visible to all org members for filtering.