Skip to main content
Version: 1.24

Update Role

Updates a role on the current portal

Parameter Reference

ParameterDescriptionSupports TokensDefault
Role IdentifierThe identifier of the role that will be updated. You can use a role name or a role ID. Can contain My Tokens.YesNone
Role Group IdentifierThe identifier of the group that will be assigned to the role. You can use a group name or a group ID, nothing changes if no input is received. Can contain My Tokens.YesNone
Role NameThe new name of the role, nothing changes if no input is received. Can contain My Tokens.YesNone
Role DescriptionThe new description of the role, nothing changes if no input is received. Can contain My Tokens.YesNone
Role StatusThe new status of the role. If you use an expression, the values accepted are -1 (Pending), 0 (Disabled), 1 (Approved), nothing changes if no input is received. Can contain My Tokens.YesNone
Add to existing usersAdd the updated role to existing users. A value of "true" or "false" should be provided, nothing changes if no input is received. Can contain My Tokens.YesNone
Is PublicIs a public role. A value of "true" or "false" should be provided, nothing changes if no input is received. Can contain My Tokens.YesNone
Auto AssignAdd the updated role to all users that will register on the portal. A value of "true" or "false" should be provided, if no input is received the role will not be added to already existing users. Can contain My Tokens.YesNone