Skip to main content
PATCH
Change a custom field

Authorizations

Authorization
string
header
required

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

Path Parameters

fieldId
string
required

The field's ID.

Body

application/json
field_label
string
options
string[]
required
boolean
sort_order
number

Response

The field, as it now is.

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.