Skip to main content
PATCH
Update a lifecycle reason

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

reason_id
integer
required

Record ID in the authenticated organization.

Example:

42

Body

application/json
expected_version
integer
required

Current reason set catalog_version; required for optimistic concurrency.

Required range: x >= 1
Example:

1

label
string

Nonblank reason label; trimmed before saving.

Maximum string length: 255
Example:

"Donor cancelled"

description
string | null

Optional explanation; whitespace normalizes to null.

Maximum string length: 500
Example:

"Donor requested cancellation."

event_transition_type
enum<string>

Applies to sponsorship.end; other contexts force their transition.

Available options:
cancelled,
ended
Example:

"cancelled"

requires_notes
boolean

Require a note for future selection.

Example:

false

is_active
boolean

Active for future lifecycle changes.

Example:

false

Response

Update a lifecycle reason completed.

data
object