Skip to main content
PATCH
Change a decision reason

Authorizations

Authorization
string
header
required

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

Path Parameters

key
string
required

The reason's key.

Body

application/json

At least one of these.

label
string
Maximum string length: 80
kind
enum<string>

Which applications the stage is for: adoption, foster, or both.

Available options:
adoption,
foster,
both
is_enabled
boolean
email_applicant
boolean | null

Choosing it ticks (true) or unticks (false) Email the applicant; null is as usual.

template_id
string | null

An active message template whose words the message starts from; null is the usual Application approved or declined words.

invite_portal
boolean | null

For a reason to approve: ticks or unticks the portal invitation; null is as usual.

Response

Every reason, and how many decisions name each.

results
object[]
required
usage
object
required

How many decisions name each reason, keyed by reason key. A reason no decision names is left out.