Creates a new role.
Creates a new role.
Subscription Level
This endpoint requires the Standard plan or higher.Required Permissions
The user must be an admin or haveworkspace-manage-config:write
permissions.Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
name
The name of the role. Must be unique.
isAdminRole
Whether this is the admin role.
Only one role can be the admin role.
isGuestRole
Whether this is the guest role.
Only one role can be the guest role.
Response
OK
name
The name of the role. Must be unique.
isAdminRole
Whether this is the admin role.
Only one role can be the admin role.
isGuestRole
Whether this is the guest role.
Only one role can be the guest role.
id
The id of the role.
isPreset
Whether this role is one of the preset roles.
Preset roles can be edited, archived and deleted.
isArchived
Whether the role has been archived.
createdBy
The id of the user who created this role.
createdOn
The date this role was created.
updatedBy
The id of the user who updated this role.
updatedOn
The date this role was last modified.