Skip to main content
POST
Create a volunteer role

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Body

application/json
label
string
required
key
string

Lower-case letters, digits and underscores, starting with a letter. Made from the label when you leave it out. It cannot be changed later.

Pattern: ^[a-z][a-z0-9_]*$
description
string
requires_qualification
boolean
default:false

Whether a person needs an approval for this role before they can sign up for it.

location_scoped
boolean
default:true

Whether an approval for this role is given per location. It cannot be changed later.

sort_order
integer
default:0

Response

The role.

id
string
required
key
string
required

A short name that never changes.

label
string
required

The name people see.

requires_qualification
boolean
required

Whether a person needs an approval for this role before they can sign up for it.

location_scoped
boolean
required

Whether an approval for this role is given per location.

is_enabled
boolean
required

false for a retired role: it cannot be put on new shifts or signed up for.

sort_order
integer
required
description
string | null
created_at
string<date-time>
updated_at
string<date-time>