Skip to main content
POST
Update Group

Authorizations

X-EntityToken
string
header
required

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Body

application/json

Updates data about a group, such as the name or default member role. Returns information about whether the update was successful. Only title claimants may modify the administration role for a group.

Updates data about a group, such as the name or default member role. Returns information about whether the update was successful. Only title claimants may modify the administration role for a group.

Group
object
required

The identifier of the group

AdminRoleId
string

Optional: the ID of an existing role to set as the new administrator role for the group

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

ExpectedProfileVersion
number

Optional field used for concurrency control. By specifying the previously returned ProfileVersion value from the GetGroup API, you can ensure that the group data update is performed only if the group has not been updated since you last loaded that version. If the same group has been updated, the requested update will not occur and the returned SetResult value will be None.

GroupName
string

Optional: the new name of the group

MemberRoleId
string

Optional: the ID of an existing role to set as the new member role for the group

Response

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Example:
Last modified on October 1, 2026