Rename preserves the Group ID and all grants. Refresh current Share labels.
PUT
/api/v1/admin/groups/{id}
const url = 'https://example.com/api/v1/admin/groups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"name":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://example.com/api/v1/admin/groups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "example" }'Route: /api/v1/admin/groups/{id}. Inputs: id. A recent account assertion is required. Do not automatically replay this operation after an uncertain result.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string format: uuid
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
Names are bounded and trimmed; control characters have no UI meaning (#1028).
object
name
required
string
Examplegenerated
{ "name": "example"}Responses
Section titled “Responses”Media typeapplication/json
Stable Group identity and its current plain name, available to share owners.
object
id
required
string format: uuid
name
required
string
Examplegenerated
{ "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example"}