Update a role

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

This endpoint updates a user role. Pass the role ID in the id path parameter.

Header parameter organization is required for authentication.

📘

Note that all the body parameters are optional. Pass only the properties that need to be updated.

🚧

When you update the permissions of the role, you must pass the entire permissions array.

Path Params
string
required

The role ID.

Body Params
string

Role name

string

Role description

boolean

If True, this role is available to all user, including those that are not logged it.

boolean

If true, this user role is granted to any newly created organization.

permissions
array of strings

An array of permission IDs

permissions
Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json