Skip to main content
PATCH
Change a catalog item

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The item's ID.

Body

application/json
label
string

Cut to 120 characters.

fields
object[]

The whole list of fields, replacing the one there.

Maximum array length: 40
notes
string | null
is_active
boolean
sort_order
integer
alters
boolean
species
enum<string>[] | null

The species it is offered for, replacing the list there. 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 now is.

item
object
required