Settings
Add new setting
POST
/
admin
/
settings
Add new setting
curl --request POST \
--url https://api.helpyousponsor.com/v1/admin/settings \
--header 'Content-Type: application/json' \
--header 'X-HYS-API-Key: <api-key>' \
--data '
{
"client_id": 1,
"name": "Setting Name",
"program_type": "contribution",
"currency_symbol": "$",
"duration": 365,
"sponsorship_amount": "10,20,50,60",
"sp_num": 100,
"processing_percentage": 2.9,
"info": "<p>sample</p>",
"text_front": "<p>sample</p>",
"text_profile": "<p>sd</p>",
"text_checkout": "<p>fs</p>",
"text_account": "<p>fs</p>",
"allow_email": true,
"show_payment": false,
"designations": true,
"login_box": true,
"stripe": false,
"checks": false,
"cash": false,
"display_percent": false,
"display_info": false,
"wire_transfer": false,
"hide_payment_method": false,
"hide_frequency": false,
"processing_fee": true,
"sorting": false,
"display_all": false,
"disable_program_link": false
}
'import requests
url = "https://api.helpyousponsor.com/v1/admin/settings"
payload = {
"client_id": 1,
"name": "Setting Name",
"program_type": "contribution",
"currency_symbol": "$",
"duration": 365,
"sponsorship_amount": "10,20,50,60",
"sp_num": 100,
"processing_percentage": 2.9,
"info": "<p>sample</p>",
"text_front": "<p>sample</p>",
"text_profile": "<p>sd</p>",
"text_checkout": "<p>fs</p>",
"text_account": "<p>fs</p>",
"allow_email": True,
"show_payment": False,
"designations": True,
"login_box": True,
"stripe": False,
"checks": False,
"cash": False,
"display_percent": False,
"display_info": False,
"wire_transfer": False,
"hide_payment_method": False,
"hide_frequency": False,
"processing_fee": True,
"sorting": False,
"display_all": False,
"disable_program_link": False
}
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,
name: 'Setting Name',
program_type: 'contribution',
currency_symbol: '$',
duration: 365,
sponsorship_amount: '10,20,50,60',
sp_num: 100,
processing_percentage: 2.9,
info: '<p>sample</p>',
text_front: '<p>sample</p>',
text_profile: '<p>sd</p>',
text_checkout: '<p>fs</p>',
text_account: '<p>fs</p>',
allow_email: true,
show_payment: false,
designations: true,
login_box: true,
stripe: false,
checks: false,
cash: false,
display_percent: false,
display_info: false,
wire_transfer: false,
hide_payment_method: false,
hide_frequency: false,
processing_fee: true,
sorting: false,
display_all: false,
disable_program_link: false
})
};
fetch('https://api.helpyousponsor.com/v1/admin/settings', 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/settings",
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,
'name' => 'Setting Name',
'program_type' => 'contribution',
'currency_symbol' => '$',
'duration' => 365,
'sponsorship_amount' => '10,20,50,60',
'sp_num' => 100,
'processing_percentage' => 2.9,
'info' => '<p>sample</p>',
'text_front' => '<p>sample</p>',
'text_profile' => '<p>sd</p>',
'text_checkout' => '<p>fs</p>',
'text_account' => '<p>fs</p>',
'allow_email' => true,
'show_payment' => false,
'designations' => true,
'login_box' => true,
'stripe' => false,
'checks' => false,
'cash' => false,
'display_percent' => false,
'display_info' => false,
'wire_transfer' => false,
'hide_payment_method' => false,
'hide_frequency' => false,
'processing_fee' => true,
'sorting' => false,
'display_all' => false,
'disable_program_link' => false
]),
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/settings"
payload := strings.NewReader("{\n \"client_id\": 1,\n \"name\": \"Setting Name\",\n \"program_type\": \"contribution\",\n \"currency_symbol\": \"$\",\n \"duration\": 365,\n \"sponsorship_amount\": \"10,20,50,60\",\n \"sp_num\": 100,\n \"processing_percentage\": 2.9,\n \"info\": \"<p>sample</p>\",\n \"text_front\": \"<p>sample</p>\",\n \"text_profile\": \"<p>sd</p>\",\n \"text_checkout\": \"<p>fs</p>\",\n \"text_account\": \"<p>fs</p>\",\n \"allow_email\": true,\n \"show_payment\": false,\n \"designations\": true,\n \"login_box\": true,\n \"stripe\": false,\n \"checks\": false,\n \"cash\": false,\n \"display_percent\": false,\n \"display_info\": false,\n \"wire_transfer\": false,\n \"hide_payment_method\": false,\n \"hide_frequency\": false,\n \"processing_fee\": true,\n \"sorting\": false,\n \"display_all\": false,\n \"disable_program_link\": false\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/settings")
.header("X-HYS-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"client_id\": 1,\n \"name\": \"Setting Name\",\n \"program_type\": \"contribution\",\n \"currency_symbol\": \"$\",\n \"duration\": 365,\n \"sponsorship_amount\": \"10,20,50,60\",\n \"sp_num\": 100,\n \"processing_percentage\": 2.9,\n \"info\": \"<p>sample</p>\",\n \"text_front\": \"<p>sample</p>\",\n \"text_profile\": \"<p>sd</p>\",\n \"text_checkout\": \"<p>fs</p>\",\n \"text_account\": \"<p>fs</p>\",\n \"allow_email\": true,\n \"show_payment\": false,\n \"designations\": true,\n \"login_box\": true,\n \"stripe\": false,\n \"checks\": false,\n \"cash\": false,\n \"display_percent\": false,\n \"display_info\": false,\n \"wire_transfer\": false,\n \"hide_payment_method\": false,\n \"hide_frequency\": false,\n \"processing_fee\": true,\n \"sorting\": false,\n \"display_all\": false,\n \"disable_program_link\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helpyousponsor.com/v1/admin/settings")
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 \"name\": \"Setting Name\",\n \"program_type\": \"contribution\",\n \"currency_symbol\": \"$\",\n \"duration\": 365,\n \"sponsorship_amount\": \"10,20,50,60\",\n \"sp_num\": 100,\n \"processing_percentage\": 2.9,\n \"info\": \"<p>sample</p>\",\n \"text_front\": \"<p>sample</p>\",\n \"text_profile\": \"<p>sd</p>\",\n \"text_checkout\": \"<p>fs</p>\",\n \"text_account\": \"<p>fs</p>\",\n \"allow_email\": true,\n \"show_payment\": false,\n \"designations\": true,\n \"login_box\": true,\n \"stripe\": false,\n \"checks\": false,\n \"cash\": false,\n \"display_percent\": false,\n \"display_info\": false,\n \"wire_transfer\": false,\n \"hide_payment_method\": false,\n \"hide_frequency\": false,\n \"processing_fee\": true,\n \"sorting\": false,\n \"display_all\": false,\n \"disable_program_link\": false\n}"
response = http.request(request)
puts response.read_body{
"message": "Settings Saved."
}{
"message": "Error message"
}Authorizations
API key generated from Developer Settings. Format: hys_...
Body
application/json
Example:
1
Example:
"Setting Name"
Example:
"contribution"
Example:
"$"
Example:
365
Example:
"10,20,50,60"
Example:
100
Example:
2.9
Example:
"<p>sample</p>"
Example:
"<p>sample</p>"
Example:
"<p>sd</p>"
Example:
"<p>fs</p>"
Example:
"<p>fs</p>"
Example:
true
Example:
false
Example:
true
Example:
true
Example:
false
Example:
false
Example:
false
Example:
false
Example:
false
Example:
false
Example:
false
Example:
false
Example:
true
Example:
false
Example:
false
Example:
false
Response
Settings Saved
Example:
"Settings Saved."
⌘I
Add new setting
curl --request POST \
--url https://api.helpyousponsor.com/v1/admin/settings \
--header 'Content-Type: application/json' \
--header 'X-HYS-API-Key: <api-key>' \
--data '
{
"client_id": 1,
"name": "Setting Name",
"program_type": "contribution",
"currency_symbol": "$",
"duration": 365,
"sponsorship_amount": "10,20,50,60",
"sp_num": 100,
"processing_percentage": 2.9,
"info": "<p>sample</p>",
"text_front": "<p>sample</p>",
"text_profile": "<p>sd</p>",
"text_checkout": "<p>fs</p>",
"text_account": "<p>fs</p>",
"allow_email": true,
"show_payment": false,
"designations": true,
"login_box": true,
"stripe": false,
"checks": false,
"cash": false,
"display_percent": false,
"display_info": false,
"wire_transfer": false,
"hide_payment_method": false,
"hide_frequency": false,
"processing_fee": true,
"sorting": false,
"display_all": false,
"disable_program_link": false
}
'import requests
url = "https://api.helpyousponsor.com/v1/admin/settings"
payload = {
"client_id": 1,
"name": "Setting Name",
"program_type": "contribution",
"currency_symbol": "$",
"duration": 365,
"sponsorship_amount": "10,20,50,60",
"sp_num": 100,
"processing_percentage": 2.9,
"info": "<p>sample</p>",
"text_front": "<p>sample</p>",
"text_profile": "<p>sd</p>",
"text_checkout": "<p>fs</p>",
"text_account": "<p>fs</p>",
"allow_email": True,
"show_payment": False,
"designations": True,
"login_box": True,
"stripe": False,
"checks": False,
"cash": False,
"display_percent": False,
"display_info": False,
"wire_transfer": False,
"hide_payment_method": False,
"hide_frequency": False,
"processing_fee": True,
"sorting": False,
"display_all": False,
"disable_program_link": False
}
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,
name: 'Setting Name',
program_type: 'contribution',
currency_symbol: '$',
duration: 365,
sponsorship_amount: '10,20,50,60',
sp_num: 100,
processing_percentage: 2.9,
info: '<p>sample</p>',
text_front: '<p>sample</p>',
text_profile: '<p>sd</p>',
text_checkout: '<p>fs</p>',
text_account: '<p>fs</p>',
allow_email: true,
show_payment: false,
designations: true,
login_box: true,
stripe: false,
checks: false,
cash: false,
display_percent: false,
display_info: false,
wire_transfer: false,
hide_payment_method: false,
hide_frequency: false,
processing_fee: true,
sorting: false,
display_all: false,
disable_program_link: false
})
};
fetch('https://api.helpyousponsor.com/v1/admin/settings', 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/settings",
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,
'name' => 'Setting Name',
'program_type' => 'contribution',
'currency_symbol' => '$',
'duration' => 365,
'sponsorship_amount' => '10,20,50,60',
'sp_num' => 100,
'processing_percentage' => 2.9,
'info' => '<p>sample</p>',
'text_front' => '<p>sample</p>',
'text_profile' => '<p>sd</p>',
'text_checkout' => '<p>fs</p>',
'text_account' => '<p>fs</p>',
'allow_email' => true,
'show_payment' => false,
'designations' => true,
'login_box' => true,
'stripe' => false,
'checks' => false,
'cash' => false,
'display_percent' => false,
'display_info' => false,
'wire_transfer' => false,
'hide_payment_method' => false,
'hide_frequency' => false,
'processing_fee' => true,
'sorting' => false,
'display_all' => false,
'disable_program_link' => false
]),
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/settings"
payload := strings.NewReader("{\n \"client_id\": 1,\n \"name\": \"Setting Name\",\n \"program_type\": \"contribution\",\n \"currency_symbol\": \"$\",\n \"duration\": 365,\n \"sponsorship_amount\": \"10,20,50,60\",\n \"sp_num\": 100,\n \"processing_percentage\": 2.9,\n \"info\": \"<p>sample</p>\",\n \"text_front\": \"<p>sample</p>\",\n \"text_profile\": \"<p>sd</p>\",\n \"text_checkout\": \"<p>fs</p>\",\n \"text_account\": \"<p>fs</p>\",\n \"allow_email\": true,\n \"show_payment\": false,\n \"designations\": true,\n \"login_box\": true,\n \"stripe\": false,\n \"checks\": false,\n \"cash\": false,\n \"display_percent\": false,\n \"display_info\": false,\n \"wire_transfer\": false,\n \"hide_payment_method\": false,\n \"hide_frequency\": false,\n \"processing_fee\": true,\n \"sorting\": false,\n \"display_all\": false,\n \"disable_program_link\": false\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/settings")
.header("X-HYS-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"client_id\": 1,\n \"name\": \"Setting Name\",\n \"program_type\": \"contribution\",\n \"currency_symbol\": \"$\",\n \"duration\": 365,\n \"sponsorship_amount\": \"10,20,50,60\",\n \"sp_num\": 100,\n \"processing_percentage\": 2.9,\n \"info\": \"<p>sample</p>\",\n \"text_front\": \"<p>sample</p>\",\n \"text_profile\": \"<p>sd</p>\",\n \"text_checkout\": \"<p>fs</p>\",\n \"text_account\": \"<p>fs</p>\",\n \"allow_email\": true,\n \"show_payment\": false,\n \"designations\": true,\n \"login_box\": true,\n \"stripe\": false,\n \"checks\": false,\n \"cash\": false,\n \"display_percent\": false,\n \"display_info\": false,\n \"wire_transfer\": false,\n \"hide_payment_method\": false,\n \"hide_frequency\": false,\n \"processing_fee\": true,\n \"sorting\": false,\n \"display_all\": false,\n \"disable_program_link\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helpyousponsor.com/v1/admin/settings")
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 \"name\": \"Setting Name\",\n \"program_type\": \"contribution\",\n \"currency_symbol\": \"$\",\n \"duration\": 365,\n \"sponsorship_amount\": \"10,20,50,60\",\n \"sp_num\": 100,\n \"processing_percentage\": 2.9,\n \"info\": \"<p>sample</p>\",\n \"text_front\": \"<p>sample</p>\",\n \"text_profile\": \"<p>sd</p>\",\n \"text_checkout\": \"<p>fs</p>\",\n \"text_account\": \"<p>fs</p>\",\n \"allow_email\": true,\n \"show_payment\": false,\n \"designations\": true,\n \"login_box\": true,\n \"stripe\": false,\n \"checks\": false,\n \"cash\": false,\n \"display_percent\": false,\n \"display_info\": false,\n \"wire_transfer\": false,\n \"hide_payment_method\": false,\n \"hide_frequency\": false,\n \"processing_fee\": true,\n \"sorting\": false,\n \"display_all\": false,\n \"disable_program_link\": false\n}"
response = http.request(request)
puts response.read_body{
"message": "Settings Saved."
}{
"message": "Error message"
}
