Skip to main content
PATCH
Change a cage card template

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The template's ID.

Body

application/json
name
string
Maximum string length: 120
paper
enum<string>

What the card is printed on: an index card (4x6, 5x7 or 6x9 inches), half a letter sheet, a letter sheet, or A5.

Available options:
index_4x6,
index_5x7,
index_6x9,
half_letter,
letter,
a5
fields
string[]

The keys of the fields to print, in order. The app prints name, pet_id, species, breed, sex, age, altered, status, location, intake_date, days_in_care, microchip_number, health_status, medical_flags, behavioral_traits, adoption_fee and description. A custom field you have added to animals is named cf: and its field key, as in cf:favourite_toy. A key this build does not know prints nothing, so a template outlives a field you delete. A new template with none sent prints no fields.

Maximum array length: 24
Required string length: 1 - 60
show_photo
boolean

True for a new template unless you say.

qr_mode
enum<string>

What the QR code points at. none prints no code. record opens the animal's record in RescueConsole, which needs a sign-in. url is an address you write in qr_url_template. site is the animal's page on your public site at your primary domain. With no address, or no live domain, no code is printed.

Available options:
none,
record,
url,
site
qr_url_template
string | null

Must start with http:// or https://. Use {pet_id}, {id} or {name} where the animal goes, as in https://contoso.com/adopt/{pet_id}.

is_default
boolean

Making one template the default takes that from the one that had it.

style
enum<string>

list prints the fields the template lists. petsmart is the PetSmart card, with its own fixed wording, the photo in one bottom corner and the QR code in the other.

Available options:
list,
petsmart
photo_corner
enum<string>

On the PetSmart card, which of its two fixed bottom marks goes on the left: the photo, or the QR code. Not the same setting as qr_corner, which places the code on a card of listed fields.

Available options:
bottom_left,
bottom_right
sponsor_logo_file_ids
string[]

IDs of PNG, JPEG, WebP or GIF images uploaded to your organization, in print order.

Maximum array length: 4
Maximum string length: 80
qr_corner
enum<string>

Which corner of the card the QR code prints in. bottom_right unless you say, which is where it has always printed. The PetSmart card ignores it: both of its marks are fixed where PetSmart puts them.

Available options:
top_left,
top_right,
bottom_left,
bottom_right

Response

The template, as it now is.

template
object
required