Skip to main content
POST
Add a fundraising 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
Available options:
donation,
campaign
field_key
string
required

Lowercase letters, digits and underscores, starting with a letter. No two fields on the same record may share one.

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

What the form calls it.

field_type
enum<string>
required

What a value must be: text any text; textarea text of 5,000 characters at most; number a number; boolean true or false; date a date; select one of the options; multiselect a list of the options; phone a phone number; email an email address; url an address starting http:// or https://; country_state an object with a two-letter country and an optional state.

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

The choices. Required, and not empty, for a select or multiselect.

required
boolean
default:false
sort_order
number
default:0

Lower comes first.

Response

The field.

id
string
entity_type
enum<string>
Available options:
donation,
campaign
field_key
string

The key its value is kept under in custom_fields.

field_label
string
field_type
enum<string>

What a value must be: text any text; textarea text of 5,000 characters at most; number a number; boolean true or false; date a date; select one of the options; multiselect a list of the options; phone a phone number; email an email address; url an address starting http:// or https://; country_state an object with a two-letter country and an optional state.

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

The choices, for a select or multiselect.

required
boolean
sort_order
number