Restore one archived sponsorship
Restores one archived donor-to-recipient sponsorship for the authenticated admin’s client, restores its commitment schedule, resets failed-payment retries, recalculates recipient sponsorship status, and refreshes table caches. The donor and recipient must both still be active. Requires permission: manage_programs and is gated by the disable_sponsorship_restore client restriction.
Authorizations
Gratona API key sent with the compatibility header X-HYS-API-Key.
Path Parameters
Archived sponsorship relationship ID to restore. The relationship must belong to the authenticated admin's client.
Body
Optional schedule date used to resume the restored recurring commitment.
Date when the restored commitment should next be processed. Validation: nullable|date_format:Y-m-d; when omitted, the commitment's existing schedule date is preserved.
"2026-08-01"
Explicitly confirms restoration when the recipient is already at capacity or this restore would exceed capacity. Omit on the first request so the API can return current donor details for confirmation.
true
Short-lived token binding the mutation to the exact previewed sponsorship and billing state. Required while sponsorship lifecycle controls are enabled.
"eyJpdiI6Ik..."
Response
Sponsorship and its commitment were restored.
"Sponsorship Successfully Restored."