Skip to main content
PUT
Update user role
This v1 endpoint is deprecated and will be removed in the coming weeks. Use PATCH /users/{email}/roles/{role_id} in the v2 API instead. Note that the v2 equivalent is a PATCH, not a PUT. The v2 path parameter is role_id, not user_role_id.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

email
string
required

User's email address

user_role_id
string<uuid>
required

The ID of the role assignment

organization_id
string
required

Body

application/json

The updated role configuration

role
enum<string>
required

The new role level (admin, editor, monitor_editor, or viewer). Note: scope cannot be changed after creation

Available options:
admin,
editor,
monitor_editor,
viewer,
team_creator

Response

Successful Response

User's access role to a resource, returned by public API.

id
string<uuid>
required

The unique identifier of this role assignment

role
enum<string>
required

The role level (admin, editor, monitor_editor, or viewer)

Available options:
admin,
editor,
monitor_editor,
viewer,
team_creator
scope
RoleScope · object
required

The scope this role applies to

created_at
string<date-time>
required

When the role was created

updated_at
string<date-time>
required

When the role was last updated

is_default
boolean
default:false

Whether this is a default organization role

granted_from_team_name
string | null

If this role is granted FROM a team (i.e., user has this role because they're a member of the team), the team name