Skip to main content
POST
Ask foster homes to take animals

Authorizations

Authorization
string
header
required

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

Body

application/json
animal_ids
string[]
required

The animals, 1 to 20.

foster_home_ids
string[]
required

The homes, 1 to 100.

note
string

Words for the fosters, up to 1,000 characters.

reason
enum<string>

Where it was asked from: record (the default), intake, list, or break.

Available options:
record,
intake,
list,
break
needed_from
string

For a break: the first day (YYYY-MM-DD).

needed_until
string

For a break: the last day (YYYY-MM-DD).

Response

What happened.

asked
integer
required

Animal and home pairs asked.

fosters_asked
integer
required

Fosters with something new to answer.

told
integer
required

Fosters told by a notice.

not_told
integer
required

Fosters asked whose fostering news is off: the ask is on their portal only.

already_asked
integer
required

Pairs left out because an ask was already open or a yes.

skipped_homes
integer
required

Homes left out because they are not active.

refused
object[]
required

The animals not asked about, and why.

batch_id
string

The ask, shared by every animal and home in it.