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]"
}
'
import requests

url = "https://api.helpyousponsor.com/v1/admin/donors/notify"

payload = {
"client_id": "1",
"hysform_id": 1,
"emailset_id": 1,
"donor_ids": "[1,2,3]"
}
headers = {
"X-HYS-API-Key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-HYS-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({client_id: '1', hysform_id: 1, emailset_id: 1, donor_ids: '[1,2,3]'})
};

fetch('https://api.helpyousponsor.com/v1/admin/donors/notify', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.helpyousponsor.com/v1/admin/donors/notify",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'client_id' => '1',
'hysform_id' => 1,
'emailset_id' => 1,
'donor_ids' => '[1,2,3]'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-HYS-API-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.helpyousponsor.com/v1/admin/donors/notify"

payload := strings.NewReader("{\n \"client_id\": \"1\",\n \"hysform_id\": 1,\n \"emailset_id\": 1,\n \"donor_ids\": \"[1,2,3]\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-HYS-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.helpyousponsor.com/v1/admin/donors/notify")
.header("X-HYS-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"client_id\": \"1\",\n \"hysform_id\": 1,\n \"emailset_id\": 1,\n \"donor_ids\": \"[1,2,3]\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.helpyousponsor.com/v1/admin/donors/notify")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-HYS-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"client_id\": \"1\",\n \"hysform_id\": 1,\n \"emailset_id\": 1,\n \"donor_ids\": \"[1,2,3]\"\n}"

response = http.request(request)
puts response.read_body
{
  "success_message": "Account Notification Emails successfully sent to 2 Donors.",
  "error_message": "1 Account Notification Email failed to send."
}
{
"message": "Error: Donor Form Not Found."
}

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."