Rename or re-describe a group

Updates the name and description. The key is not part of the request:
it is immutable, so policies referencing it never silently re-point.

Requires the group:manage permission, and the path tenant must equal
the caller's tenant_id claim. A deactivated group cannot be edited.

Path Params
uuid
required

The tenant. Must equal the caller's tenant_id claim; a mismatch is
403 Invalid tenant id.

uuid
required

The approval group. One belonging to another tenant reads as 404, the
same as one that does not exist.

Body Params

The editable parts of a group. The key is deliberately absent; it is
immutable after creation.

string
required
length between 1 and 100
string | null

Trimmed; a blank value is stored as null.

Headers
string
required
^\d+\.\d+\.\d+$

The version of the Quant Flow API the request follows, as major.minor.patch (for example 1.0.0). The request is interpreted, and the response shaped, according to that version.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json