Skip to main content
POST
Archive Sponsorships for Donors

Authorizations

X-HYS-API-Key
string
header
required

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

Body

application/json

Data needed to archive sponsorships for a donor

donor_entity_ids
integer[]
Example:
preview_token
string

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

Example:

"eyJpdiI6Ik..."

reason_code
string | null
Example:

"donor_cancelled"

notes
string | null
Maximum string length: 2000
effective_at
string<date> | null

Response

Successful operation

message
string
Example:

"Sponsorships Successfully Removed."