Skip to main content
POST
Restore one archived sponsorship

Authorizations

X-HYS-API-Key
string
header
required

Gratona API key sent with the compatibility header X-HYS-API-Key.

Path Parameters

donor_entity_id
integer<int64>
required

Archived sponsorship relationship ID to restore. The relationship must belong to the authenticated admin's client.

Body

application/json

Optional schedule date used to resume the restored recurring commitment.

next_action_date
string<date> | null

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.

Example:

"2026-08-01"

force_restore
boolean | null

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.

Example:

true

preview_token
string

Short-lived token binding the mutation to the exact previewed sponsorship and billing state. Required while sponsorship lifecycle controls are enabled.

Example:

"eyJpdiI6Ik..."

Response

Sponsorship and its commitment were restored.

message
string
Example:

"Sponsorship Successfully Restored."