Change a custom field
curl --request PATCH \
--url https://{organization}.rescueconsole.com/api/shifts/custom-fields/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"field_label": "Store contact",
"required": true
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({field_label: 'Store contact', required: true})
};
fetch('https://{organization}.rescueconsole.com/api/shifts/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/shifts/custom-fields/{id}"
payload = {
"field_label": "Store contact",
"required": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"entity_type": "volunteer_event",
"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)"
}Shift custom fields
Change a custom field
Changes a field’s label, choices, whether it is required, or its place in the order. Send only what changes. Its key, its type and the kind of record it is on cannot be changed. Needs admin on Shifts.
PATCH
/
api
/
shifts
/
custom-fields
/
{id}
Change a custom field
curl --request PATCH \
--url https://{organization}.rescueconsole.com/api/shifts/custom-fields/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"field_label": "Store contact",
"required": true
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({field_label: 'Store contact', required: true})
};
fetch('https://{organization}.rescueconsole.com/api/shifts/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/shifts/custom-fields/{id}"
payload = {
"field_label": "Store contact",
"required": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"entity_type": "volunteer_event",
"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.
volunteer_event is a schedule, shift a shift, and shift_signup a sign-up.
Available options:
volunteer_event, shift, shift_signup The key its value is stored under in custom_fields.
Available options:
text, number, boolean, date, select, multiselect The choices, for select and multiselect.
Whether a new record must have a value for it.