Skip to main content
PATCH
Change a contract 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

Send only what changes. Sending body or body_blocks replaces the other. Contracts already signed keep the text they were signed with.

name
string

What the template is called.

version
string

Your own label for this version, such as 2026-standard. A name and version can be used once.

kind
enum<string>

What it is signed on: an adoption, a transport run, a foster placement, a surrender (an intake), or other.

Available options:
adoption,
foster,
surrender,
other,
transport
body
string

The contract as plain text. Merge fields are written in double braces, such as {{adopter_name}}.

body_blocks
object[]

The contract as a formatted document. When sent, its text becomes the body.

conditions
object

When a template is offered. Every condition given must hold; none at all means every animal. A key not listed here is refused.

field_conditions
object[]

Conditions on the animal's or the adopter's own fields. Every one must hold.

Maximum array length: 10
asks
enum<string>[]

What is asked at signing: the media release, the payment and how to complete it, the team member approving, and where it was completed.

Available options:
media_release,
payment,
approver,
completed_where
is_active
boolean

false retires it; true brings a retired template back.

for_destination_type
enum<string> | null

A transport agreement only for runs ending at this kind of place; null for any transport. Refused on any other kind of template: a rule that would never be read is worse kept than refused. The closed-set conditions and field_conditions are refused on a transport agreement for the same reason - they are about the animal and the adopter, and a run has neither.

Available options:
residence,
shelter,
vet,
break_stop,
other,
null

Response

The template, as it now is.

template
object
required