Skip to main content
POST
Reassign a sponsorship recipient

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

donor_entity_id
integer
required

Record ID in the authenticated organization.

Example:

42

Body

application/json
entity_id
integer
required

Replacement active visible recipient in an accessible program.

Required range: x >= 1
Example:

42

transition_type
enum<string>
required

Supported transition.

Available options:
reassigned
Example:

"reassigned"

expected_version
integer
required

Current sponsorship lifecycle_version.

Required range: x >= 1
Example:

1

idempotency_key
string<uuid>
required

Stable retry UUID for this exact reassignment command.

Example:

"d38103d8-1e8b-47ab-ae04-7e1f8a3bc727"

payment_continuity_confirmed
boolean
required

Must be accepted; confirms existing payments continue for the replacement recipient.

Example:

true

reason_code
string | null

Active context reason; required by catalog policy where configured.

Maximum string length: 100
Example:

"donor_requested_change"

notes
string | null

Context note; required for reasons configured to need notes.

Maximum string length: 2000
Example:

"Donor requested another recipient."

effective_at
string<date-time> | null

Business effective time; defaults now.

Example:

"2026-10-20T12:00:00Z"

Response

Reassign a sponsorship recipient completed.

message
string

Reassignment or replay confirmation.

Example:

"Commitment successfully reassigned."

replayed
boolean

This exact command was already applied.

Example:

false

event
object
sponsorship
object