Sponsorships
Add a new sponsorship
POST
/
admin
/
sponsorships
Add a new sponsorship
curl --request POST \
--url https://api.helpyousponsor.com/v1/admin/sponsorships \
--header 'Content-Type: application/json' \
--header 'X-HYS-API-Key: <api-key>' \
--data '
{
"donors": 1,
"id": 1,
"sp_amount": "100",
"client_id": "1",
"entity_id": 1,
"entities": 1,
"method": "3",
"frequency": "1",
"next": "2023-11-25"
}
'import requests
url = "https://api.helpyousponsor.com/v1/admin/sponsorships"
payload = {
"donors": 1,
"id": 1,
"sp_amount": "100",
"client_id": "1",
"entity_id": 1,
"entities": 1,
"method": "3",
"frequency": "1",
"next": "2023-11-25"
}
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({
donors: 1,
id: 1,
sp_amount: '100',
client_id: '1',
entity_id: 1,
entities: 1,
method: '3',
frequency: '1',
next: '2023-11-25'
})
};
fetch('https://api.helpyousponsor.com/v1/admin/sponsorships', 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/sponsorships",
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([
'donors' => 1,
'id' => 1,
'sp_amount' => '100',
'client_id' => '1',
'entity_id' => 1,
'entities' => 1,
'method' => '3',
'frequency' => '1',
'next' => '2023-11-25'
]),
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/sponsorships"
payload := strings.NewReader("{\n \"donors\": 1,\n \"id\": 1,\n \"sp_amount\": \"100\",\n \"client_id\": \"1\",\n \"entity_id\": 1,\n \"entities\": 1,\n \"method\": \"3\",\n \"frequency\": \"1\",\n \"next\": \"2023-11-25\"\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/sponsorships")
.header("X-HYS-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"donors\": 1,\n \"id\": 1,\n \"sp_amount\": \"100\",\n \"client_id\": \"1\",\n \"entity_id\": 1,\n \"entities\": 1,\n \"method\": \"3\",\n \"frequency\": \"1\",\n \"next\": \"2023-11-25\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helpyousponsor.com/v1/admin/sponsorships")
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 \"donors\": 1,\n \"id\": 1,\n \"sp_amount\": \"100\",\n \"client_id\": \"1\",\n \"entity_id\": 1,\n \"entities\": 1,\n \"method\": \"3\",\n \"frequency\": \"1\",\n \"next\": \"2023-11-25\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Sponsorship relationship successfully created."
}{
"message": "Donor Not Found."
}Authorizations
API key generated from Developer Settings. Format: hys_...
Body
application/json
Data required to create a new sponsorship
Donor ID
Example:
1
Donor ID
Example:
1
Sponsorship amount
Example:
"100"
Example:
"1"
Entity ID
Example:
1
Entity ID
Example:
1
Payment method
Example:
"3"
Frequency of payment
Example:
"1"
Example:
"2023-11-25"
Response
Sponsorship relationship successfully created
Example:
"Sponsorship relationship successfully created."
⌘I
Add a new sponsorship
curl --request POST \
--url https://api.helpyousponsor.com/v1/admin/sponsorships \
--header 'Content-Type: application/json' \
--header 'X-HYS-API-Key: <api-key>' \
--data '
{
"donors": 1,
"id": 1,
"sp_amount": "100",
"client_id": "1",
"entity_id": 1,
"entities": 1,
"method": "3",
"frequency": "1",
"next": "2023-11-25"
}
'import requests
url = "https://api.helpyousponsor.com/v1/admin/sponsorships"
payload = {
"donors": 1,
"id": 1,
"sp_amount": "100",
"client_id": "1",
"entity_id": 1,
"entities": 1,
"method": "3",
"frequency": "1",
"next": "2023-11-25"
}
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({
donors: 1,
id: 1,
sp_amount: '100',
client_id: '1',
entity_id: 1,
entities: 1,
method: '3',
frequency: '1',
next: '2023-11-25'
})
};
fetch('https://api.helpyousponsor.com/v1/admin/sponsorships', 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/sponsorships",
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([
'donors' => 1,
'id' => 1,
'sp_amount' => '100',
'client_id' => '1',
'entity_id' => 1,
'entities' => 1,
'method' => '3',
'frequency' => '1',
'next' => '2023-11-25'
]),
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/sponsorships"
payload := strings.NewReader("{\n \"donors\": 1,\n \"id\": 1,\n \"sp_amount\": \"100\",\n \"client_id\": \"1\",\n \"entity_id\": 1,\n \"entities\": 1,\n \"method\": \"3\",\n \"frequency\": \"1\",\n \"next\": \"2023-11-25\"\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/sponsorships")
.header("X-HYS-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"donors\": 1,\n \"id\": 1,\n \"sp_amount\": \"100\",\n \"client_id\": \"1\",\n \"entity_id\": 1,\n \"entities\": 1,\n \"method\": \"3\",\n \"frequency\": \"1\",\n \"next\": \"2023-11-25\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helpyousponsor.com/v1/admin/sponsorships")
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 \"donors\": 1,\n \"id\": 1,\n \"sp_amount\": \"100\",\n \"client_id\": \"1\",\n \"entity_id\": 1,\n \"entities\": 1,\n \"method\": \"3\",\n \"frequency\": \"1\",\n \"next\": \"2023-11-25\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Sponsorship relationship successfully created."
}{
"message": "Donor Not Found."
}
