Archive Sponsorships for Donors - HelpYouSponsor Docs

POST

admin

sponsorships

archive

Archive Sponsorships for Donors

curl --request POST \
  --url https://api.helpyousponsor.com/v1/admin/sponsorships/archive \
  --header 'Content-Type: application/json' \
  --header 'X-HYS-API-Key: <api-key>' \
  --data '
{
  "donor_entity_ids": "[1, 2, 3]"
}
'

{
  "message": "Sponsorships Successfully Removed."
}

Authorizations

X-HYS-API-Key

string

header

required

API key generated from Developer Settings. Format: hys_...

Body

application/json

Data needed to archive sponsorships for a donor

donor_entity_ids

integer[]

Example:

"[1, 2, 3]"

Response

Successful operation

message

string

Example:

"Sponsorships Successfully Removed."

Donors and Available EntitiesReturns donors and available entities

Archive Sponsorships for Donors

curl --request POST \
  --url https://api.helpyousponsor.com/v1/admin/sponsorships/archive \
  --header 'Content-Type: application/json' \
  --header 'X-HYS-API-Key: <api-key>' \
  --data '
{
  "donor_entity_ids": "[1, 2, 3]"
}
'

{
  "message": "Sponsorships Successfully Removed."
}