Skip to main content
POST

Authorizations

Authorization
string
header
required

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

Body

application/json
action
enum<string>
required
Available options:
set_status,
add_tag,
remove_tag,
update,
delete
value
string

For set_status, the status key; for add_tag and remove_tag, the tag.

patch
object

For update: the fields to set on every animal. Any other field is refused.

ids
string[]

The animals' record IDs. Every one must be yours, or nothing changes and the answer is 404.

Required array length: 1 - 200 elements
filter
string

A query string of list filters. Refused when nothing matches or more than 200 match.

Response

What was done.

updated
integer

How many animals changed.

unchanged
integer

For set_status and update: how many already held every value.

action
enum<string>
Available options:
set_status,
add_tag,
remove_tag,
update,
delete
value
string

The value sent, or empty.