Skip to main content
PATCH
Change a fundraising custom field

Authorizations

Authorization
string
header
required

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

Path Parameters

id
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
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