Skip to main content
POST
Create Role

Authorizations

Authorization
string
header
required

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

Body

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

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