Skip to main content
POST
Create a role

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Body

application/json

The new Role resource

name
string
namePlural
string | null
unitType
string<iri-reference> | null
Example:

"/api/v1/unit_types/1"

position
integer | null
isUserType
boolean | null
options
(string | null)[] | null
isLocalCenter
boolean | null
isLocalCenterParent
boolean | null
isNational
boolean | null
permissions
(string | null)[] | null
chartName
string | null
isNotEligibleForFee
boolean | null
isParent
boolean | null
isVolunteer
boolean | null
slug
string | null

Response

Role resource created

id
integer
read-only
name
string
namePlural
string | null
unitType
object | null
position
integer | null
isUserType
boolean | null
options
(string | null)[] | null
isLocalCenter
boolean | null
isLocalCenterParent
boolean | null
isNational
boolean | null
permissions
(string | null)[] | null
chartName
string | null
isNotEligibleForFee
boolean | null
isParent
boolean | null
isVolunteer
boolean | null
slug
string | null