curl --request PATCH \
--url https://{organization}.rescueconsole.com/api/fundraising/custom-fields/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"field_label": "In memory or in honor of",
"sort_order": 5
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({field_label: 'In memory or in honor of', sort_order: 5})
};
fetch('https://{organization}.rescueconsole.com/api/fundraising/custom-fields/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/fundraising/custom-fields/{id}"
payload = {
"field_label": "In memory or in honor of",
"sort_order": 5
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"entity_type": "donation",
"field_key": "<string>",
"field_label": "<string>",
"field_type": "text",
"options": [
"<string>"
],
"required": true,
"sort_order": 123
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}Change a fundraising custom field
The label, the choices, whether it is required and its place in the order can change. Its key, its type and which record it is on cannot. Sending options replaces the choices. Needs admin on Fundraising.
curl --request PATCH \
--url https://{organization}.rescueconsole.com/api/fundraising/custom-fields/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"field_label": "In memory or in honor of",
"sort_order": 5
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({field_label: 'In memory or in honor of', sort_order: 5})
};
fetch('https://{organization}.rescueconsole.com/api/fundraising/custom-fields/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/fundraising/custom-fields/{id}"
payload = {
"field_label": "In memory or in honor of",
"sort_order": 5
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"entity_type": "donation",
"field_key": "<string>",
"field_label": "<string>",
"field_type": "text",
"options": [
"<string>"
],
"required": true,
"sort_order": 123
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}Authorizations
An API key from Settings, API keys. It starts with rc_live_.
Path Parameters
The field's ID.
Response
The field, as it now is.
donation, campaign The key its value is kept under in custom_fields.
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.
text, textarea, number, boolean, date, select, multiselect, phone, email, url, country_state The choices, for a select or multiselect.