Change a foster home
curl --request PATCH \
--url https://{organization}.rescueconsole.com/api/animals/foster-homes/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "paused",
"notes": "Away until October."
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({status: 'paused', notes: 'Away until October.'})
};
fetch('https://{organization}.rescueconsole.com/api/animals/foster-homes/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/animals/foster-homes/{id}"
payload = {
"status": "paused",
"notes": "Away until October."
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"foster_home": {
"id": "<string>",
"person_id": "<string>",
"status": "active",
"capacity": 123,
"spots_filled": 123,
"spots_available": 123,
"is_full": true,
"species_preferences": [
"<string>"
],
"accepts_medical": true,
"accepts_bottle_babies": true,
"accepts_behavioral": true,
"approved_on": "<string>",
"notes": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"person": {
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"display_name": "<string>",
"email": "<string>",
"phone": "<string>"
}
}
}{
"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)"
}Foster homes
Change a foster home
Send only what changes. Pausing a home keeps the animals it has, and stops it being offered more. The capacity may go below what is placed there now: the home then shows as over capacity rather than the change being refused. Needs write on Animals.
PATCH
/
api
/
animals
/
foster-homes
/
{id}
Change a foster home
curl --request PATCH \
--url https://{organization}.rescueconsole.com/api/animals/foster-homes/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "paused",
"notes": "Away until October."
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({status: 'paused', notes: 'Away until October.'})
};
fetch('https://{organization}.rescueconsole.com/api/animals/foster-homes/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/animals/foster-homes/{id}"
payload = {
"status": "paused",
"notes": "Away until October."
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"foster_home": {
"id": "<string>",
"person_id": "<string>",
"status": "active",
"capacity": 123,
"spots_filled": 123,
"spots_available": 123,
"is_full": true,
"species_preferences": [
"<string>"
],
"accepts_medical": true,
"accepts_bottle_babies": true,
"accepts_behavioral": true,
"approved_on": "<string>",
"notes": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"person": {
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"display_name": "<string>",
"email": "<string>",
"phone": "<string>"
}
}
}{
"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 foster home's ID (not the person's).
Body
application/json
A paused or inactive home keeps its animals but shows no free spots and cannot be offered one.
Available options:
active, paused, inactive Can go below what is placed there now: the home is then over capacity.
Required range:
x >= 1Replaces the list. Empty means any.
Null or empty text clears it.
Null or empty text clears it.
Response
The foster home, as it now is.
Show child attributes
Show child attributes