Skip to main content
POST
Create role

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Body

application/json
scope
enum<string>
required

Fixed after creation

Available options:
tenant,
company
name
string
required
Required string length: 1 - 50
description
string | null
Maximum string length: 2000
bypass_company_restrictions
boolean

Staff with this role see every company, not only assigned ones

receive_update_emails
boolean
quote_visibility
enum<string>
Available options:
all,
own,
site
quote_stage_filter
string[] | null

Quote stages visible to the role; null or [] means every stage

Maximum array length: 50
Required string length: 1 - 120

Response

Role created

data
object
required