Notes
Create a new note
POST
/
admin
/
notes
/
{type}
/
{program_id}
Create a new note
curl --request POST \
--url https://api.helpyousponsor.com/v1/admin/notes/{type}/{program_id} \
--header 'Content-Type: application/json' \
--header 'X-HYS-API-Key: <api-key>' \
--data '
{
"note": "This is a note.",
"entity_id": "1",
"donor_id": "1",
"client_id": "1",
"program_id": "donor",
"type": "donor",
"categories": "ALL"
}
'import requests
url = "https://api.helpyousponsor.com/v1/admin/notes/{type}/{program_id}"
payload = {
"note": "This is a note.",
"entity_id": "1",
"donor_id": "1",
"client_id": "1",
"program_id": "donor",
"type": "donor",
"categories": "ALL"
}
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({
note: 'This is a note.',
entity_id: '1',
donor_id: '1',
client_id: '1',
program_id: 'donor',
type: 'donor',
categories: 'ALL'
})
};
fetch('https://api.helpyousponsor.com/v1/admin/notes/{type}/{program_id}', 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/notes/{type}/{program_id}",
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([
'note' => 'This is a note.',
'entity_id' => '1',
'donor_id' => '1',
'client_id' => '1',
'program_id' => 'donor',
'type' => 'donor',
'categories' => 'ALL'
]),
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/notes/{type}/{program_id}"
payload := strings.NewReader("{\n \"note\": \"This is a note.\",\n \"entity_id\": \"1\",\n \"donor_id\": \"1\",\n \"client_id\": \"1\",\n \"program_id\": \"donor\",\n \"type\": \"donor\",\n \"categories\": \"ALL\"\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/notes/{type}/{program_id}")
.header("X-HYS-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"note\": \"This is a note.\",\n \"entity_id\": \"1\",\n \"donor_id\": \"1\",\n \"client_id\": \"1\",\n \"program_id\": \"donor\",\n \"type\": \"donor\",\n \"categories\": \"ALL\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helpyousponsor.com/v1/admin/notes/{type}/{program_id}")
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 \"note\": \"This is a note.\",\n \"entity_id\": \"1\",\n \"donor_id\": \"1\",\n \"client_id\": \"1\",\n \"program_id\": \"donor\",\n \"type\": \"donor\",\n \"categories\": \"ALL\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Successful"
}{
"message": "Error: Note is required."
}Authorizations
API key generated from Developer Settings. Format: hys_...
Body
application/json
Input data format
Response
Successful operation
Success message
Example:
"Successful"
⌘I
Create a new note
curl --request POST \
--url https://api.helpyousponsor.com/v1/admin/notes/{type}/{program_id} \
--header 'Content-Type: application/json' \
--header 'X-HYS-API-Key: <api-key>' \
--data '
{
"note": "This is a note.",
"entity_id": "1",
"donor_id": "1",
"client_id": "1",
"program_id": "donor",
"type": "donor",
"categories": "ALL"
}
'import requests
url = "https://api.helpyousponsor.com/v1/admin/notes/{type}/{program_id}"
payload = {
"note": "This is a note.",
"entity_id": "1",
"donor_id": "1",
"client_id": "1",
"program_id": "donor",
"type": "donor",
"categories": "ALL"
}
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({
note: 'This is a note.',
entity_id: '1',
donor_id: '1',
client_id: '1',
program_id: 'donor',
type: 'donor',
categories: 'ALL'
})
};
fetch('https://api.helpyousponsor.com/v1/admin/notes/{type}/{program_id}', 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/notes/{type}/{program_id}",
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([
'note' => 'This is a note.',
'entity_id' => '1',
'donor_id' => '1',
'client_id' => '1',
'program_id' => 'donor',
'type' => 'donor',
'categories' => 'ALL'
]),
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/notes/{type}/{program_id}"
payload := strings.NewReader("{\n \"note\": \"This is a note.\",\n \"entity_id\": \"1\",\n \"donor_id\": \"1\",\n \"client_id\": \"1\",\n \"program_id\": \"donor\",\n \"type\": \"donor\",\n \"categories\": \"ALL\"\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/notes/{type}/{program_id}")
.header("X-HYS-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"note\": \"This is a note.\",\n \"entity_id\": \"1\",\n \"donor_id\": \"1\",\n \"client_id\": \"1\",\n \"program_id\": \"donor\",\n \"type\": \"donor\",\n \"categories\": \"ALL\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helpyousponsor.com/v1/admin/notes/{type}/{program_id}")
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 \"note\": \"This is a note.\",\n \"entity_id\": \"1\",\n \"donor_id\": \"1\",\n \"client_id\": \"1\",\n \"program_id\": \"donor\",\n \"type\": \"donor\",\n \"categories\": \"ALL\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Successful"
}{
"message": "Error: Note is required."
}
