Skip to main content
POST
Update Role

Authorizations

X-EntityToken
string
header
required

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

Body

application/json

Updates the role name. Returns information about whether the update was successful.

Updates the role name. Returns information about whether the update was successful.

Group
object
required

The identifier of the group

RoleName
string
required

The new name of the role

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 role 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.

RoleId
string

ID of the role to update. Role IDs must be between 1 and 64 characters long.

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