Skip to main content
POST
Add a custom field

Authorizations

Authorization
string
header
required

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

Body

application/json
field_key
string
required

Lower case letters, digits and underscores, starting with a letter. Unique among your person fields.

Pattern: ^[a-z][a-z0-9_]*$
field_label
string
required

What the record shows.

field_type
enum<string>
required

textarea is long text, select is one choice, multiselect several, country_state a country and state.

Available options:
text,
textarea,
number,
boolean,
date,
select,
multiselect,
phone,
email,
url,
country_state
options
string[]

The choices. Needed for select and multiselect.

required
boolean
default:false

A new person cannot be added without it.

sort_order
number
default:0

Response

The field.

id
string
required

For a built-in field, builtin_ and its key.

entity_type
enum<string>
required
Available options:
person
field_key
string
required
field_label
string
required
field_type
enum<string>
required

The last three belong to built-in fields only: an organization picked from the directory, a person on file, and a list of volunteer roles.

Available options:
text,
textarea,
number,
boolean,
date,
select,
multiselect,
phone,
email,
url,
country_state,
organization,
person,
volunteer_roles
options
string[]
required
required
boolean
required
sort_order
number
required
builtin
boolean

Present and true on a built-in field.

section
string | null

For a built-in field: the section of the record it sits in, such as Housing.

default_roles
enum<string>[]

For a built-in field: the roles it is shown for unless you arrange otherwise.

Available options:
adopter,
donor,
volunteer,
foster
note
string | null

For a built-in field: a hint shown beside it.