Skip to main content
POST
/
admin
/
donors
/
notify
Send notification to donors
curl --request POST \
  --url https://api.helpyousponsor.com/v1/admin/donors/notify \
  --header 'Content-Type: application/json' \
  --header 'X-HYS-API-Key: <api-key>' \
  --data '
{
  "client_id": "1",
  "hysform_id": 1,
  "emailset_id": 1,
  "donor_ids": "[1,2,3]"
}
'
{
  "success_message": "Account Notification Emails successfully sent to 2 Donors.",
  "error_message": "1 Account Notification Email failed to send."
}

Documentation Index

Fetch the complete documentation index at: https://api-docs.helpyousponsor.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-HYS-API-Key
string
header
required

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

Body

application/json

Data needed to send notification to donors

​
client_id
string

The id of the client

Example:

"1"

​
hysform_id
integer

The id of the form

Example:

1

​
emailset_id
integer
Example:

1

​
donor_ids
integer[]
Example:

"[1,2,3]"

Response

Successful operation

​
success_message
string
Example:

"Account Notification Emails successfully sent to 2 Donors."

​
error_message
string
Example:

"1 Account Notification Email failed to send."