Skip to main content
PATCH
Change an adoption follow-up

Authorizations

Authorization
string
header
required

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

Path Parameters

templateId
string
required

The follow-up's ID.

Body

application/json
label
string
Required string length: 1 - 120
offset_days
integer

How many days after the adoption day it is due. 0 is the same day.

Required range: 0 <= x <= 3650
is_active
boolean

false turns it off: adoptions finalized afterwards make no task for it.

sort_order
integer

Where it sits in the list, lowest first.

action
enum<string>
default:task

What it does when an adoption is finalized: a task on the animal, an email to the adopter from template_key, or both.

Available options:
task,
email,
both
template_key
string | null

The message template the email sends, by key. Required when action is email or both; it must be an active template.

Response

The follow-up as it is now.

template
object
required