Skip to main content
POST
Add a catalog item

Authorizations

Authorization
string
header
required

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

Body

application/json
kind
enum<string>
required

A condition is a lasting fact about the animal, such as FIV positive; a diagnosis is an episode with a date.

Available options:
diagnosis,
test,
vaccine,
treatment,
procedure,
condition
label
string
required

Cut to 120 characters.

key
string

Made from the label unless you give one. Turned into lowercase letters, digits and underscores, at most 40 characters.

fields
object[]
Maximum array length: 40
notes
string | null

Cut to 1,000 characters.

alters
boolean
default:false
species
enum<string>[] | null

The species it is offered for. Left out, null or an empty list: every species.

Available options:
dog,
cat,
rabbit,
equine,
small_mammal,
large_mammal,
bird,
barnyard,
fish,
reptile,
exotic
cost_cents
integer | null

What one costs the rescue, in cents (null is not known). A record of it marked given or done with no cost of its own starts with this; a record keeps the cost it was made with when this changes. Never a price charged to the public.

Required range: 0 <= x <= 10000000
note_text
string | null

The notes a record made from it starts with when none are written.

Maximum string length: 1000
done_text
string | null

Added after a record's notes when it is done, once.

Maximum string length: 1000

Response

The item, as it was created.

item
object
required