Skip to main content
POST
/
roles
Create Role
curl --request POST \
  --url https://api.{your-broker}.slate-labs.com/roles \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "display_name": "<string>",
  "description": "<string>",
  "customer_scope": "own",
  "customer_access": "view",
  "customer_view_scope": "own",
  "customer_edit_scope": "none",
  "pii_email": "masked",
  "pii_phone": "masked",
  "can_export_pii": false,
  "level": 0
}
'
{
  "id": 123,
  "name": "<string>",
  "display_name": "<string>",
  "description": "<string>",
  "customer_scope": "<string>",
  "customer_access": "<string>",
  "customer_view_scope": "<string>",
  "customer_edit_scope": "<string>",
  "pii_email": "<string>",
  "pii_phone": "<string>",
  "can_export_pii": true,
  "level": 123,
  "is_system": true,
  "is_active": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

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