Skip to main content
PATCH
Change a volunteer role

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The role's ID.

Body

application/json
label
string
description
string | null

Null clears it.

requires_qualification
boolean
is_enabled
boolean

false retires the role; true brings it back.

sort_order
integer

Response

The role, as it now is.

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>