Archive donors - HelpYouSponsor Docs

POST

/

admin

/

donors

/

archive

Archive donors

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

{
  "message": "Successfully archived donor(s)."
}

Authorizations

X-HYS-API-Key

string

header

required

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

Body

application/json

donor_ids

integer[]

required

Example:

"[1,2,3]"

hysform_id

integer

Example:

1

client_id

string

Example:

"1"

Response

Successful operation

message

string

Example:

"Successfully archived donor(s)."

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

{
  "message": "Successfully archived donor(s)."
}