Skip to main content
PATCH
Update Role

Authorizations

Authorization
string
header
required

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

Path Parameters

role_id
integer
required

Body

application/json
display_name
string | null
Required string length: 1 - 128
description
string | null
customer_scope
enum<string> | null
Available options:
own,
team,
all
customer_access
enum<string> | null
Available options:
view,
edit
customer_view_scope
enum<string> | null
Available options:
own,
team,
all
customer_edit_scope
enum<string> | null
Available options:
none,
own,
team,
all
pii_email
enum<string> | null
Available options:
full,
masked,
hidden
pii_phone
enum<string> | null
Available options:
full,
masked,
hidden
can_export_pii
boolean | null
level
integer | null
Required range: x >= 0
is_active
boolean | null

Response

Successful Response

id
integer
required
name
string
required
display_name
string
required
description
string | null
required
customer_scope
string
required
customer_access
string
required
customer_view_scope
string
required
customer_edit_scope
string
required
pii_email
string
required
pii_phone
string
required
can_export_pii
boolean
required
level
integer
required
is_system
boolean
required
is_active
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required