Skip to main content
POST
/
admin
/
donors
/
send_year_end
Send year end statements to donors
curl --request POST \
  --url https://api.helpyousponsor.com/v1/admin/donors/send_year_end \
  --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]",
  "year": 2020
}
'
{
  "success_message": "2020 Year End Statements successfully sent to 5 Donors.",
  "error_message": "Error: 2020 Year End Statements failed to send to 2 Donors"
}

Authorizations

​
X-HYS-API-Key
string
header
required

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

Body

application/json

Data needed to send year end statements 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]"

​
year
integer

The year of the statement

Example:

2020

Response

Successful operation

​
success_message
string
Example:

"2020 Year End Statements successfully sent to 5 Donors."

​
error_message
string
Example:

"Error: 2020 Year End Statements failed to send to 2 Donors"