Skip to main content
POST
Join two cages

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The unit's ID.

Body

application/json
with_unit_id
string
required

The other cage.

Response

This cage, as it now is.

id
string
required
unit_type
enum<string>
required

A foster home and a virtual placement are not space in a building.

Available options:
campus,
building,
room,
cage,
foster_home,
virtual
name
string
required
capacity
integer
required

How many animals it holds. 0 means it is not counted.

combined_with
string[]
required

The cages joined to this one by tunnels. Every cage in a space lists every other one.

status
enum<string>
required

active is in service. out_of_service is not in use for now. inactive is retired.

Available options:
active,
inactive,
out_of_service
effective_capacity
integer
required

The capacity of the whole space: this unit and every cage joined to it.

effective_occupants
integer
required

Animals in care in the whole space: this unit and every cage joined to it. Only animals placed in the unit itself count, not animals in units inside it.

parent_id
string | null

The unit this one is inside, or null for one at the top.

is_virtual
boolean

True for a foster home or a virtual placement. It follows from the type.

foster_person_id
string | null

The person, for a foster home unit.

org_location_id
string | null

Set when this unit stands for one of your locations in Settings. Its name, type, parent and status are changed there, under Locations, and not here.

sort_order
integer

Its place among the units inside the same parent.

custom_fields
object

Your own location fields, by field key.

created_at
string<date-time>
updated_at
string<date-time>