Skip to main content
POST
Create a custom field

Authorizations

Authorization
string
header
required

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

Body

application/json
entity_type
enum<string>
required

volunteer_event is a schedule, shift a shift, and shift_signup a sign-up.

Available options:
volunteer_event,
shift,
shift_signup
field_key
string
required

Lower-case letters, digits and underscores, starting with a letter. Unique for the kind of record.

Pattern: ^[a-z][a-z0-9_]*$
field_label
string
required
field_type
enum<string>
required
Available options:
text,
number,
boolean,
date,
select,
multiselect
options
string[]

Required, and not empty, for select and multiselect.

required
boolean
default:false
sort_order
integer
default:0

Response

The field.

id
string
required
entity_type
enum<string>
required

volunteer_event is a schedule, shift a shift, and shift_signup a sign-up.

Available options:
volunteer_event,
shift,
shift_signup
field_key
string
required

The key its value is stored under in custom_fields.

field_label
string
required
field_type
enum<string>
required
Available options:
text,
number,
boolean,
date,
select,
multiselect
options
string[]
required

The choices, for select and multiselect.

required
boolean
required

Whether a new record must have a value for it.

sort_order
integer
required