Admins & Permissions
Create a new group
POST
/
admin
/
groups
Create a new group
curl --request POST \
--url https://api.helpyousponsor.com/v1/admin/groups \
--header 'Content-Type: application/json' \
--header 'X-HYS-API-Key: <api-key>' \
--data '
{
"account": "",
"admins": "",
"donations": "",
"email_manager": "",
"form_report": "",
"forms": "",
"disable_entity_archive": "",
"manage_designations": "",
"manage_email": "",
"manage_programs": "",
"manage_settings": "",
"new_form": "",
"group_all": "1",
"groups": "",
"disable_donor_archive": "",
"disable_donor_delete": "",
"disable_donor_restore": "",
"disable_entity_delete": "",
"disable_entity_restore": "",
"disable_message_send_without_approval": "",
"client_id": "207",
"name": "sample",
"group_id": "",
"program-929": "1",
"donor-639": "1"
}
'import requests
url = "https://api.helpyousponsor.com/v1/admin/groups"
payload = {
"account": "",
"admins": "",
"donations": "",
"email_manager": "",
"form_report": "",
"forms": "",
"disable_entity_archive": "",
"manage_designations": "",
"manage_email": "",
"manage_programs": "",
"manage_settings": "",
"new_form": "",
"group_all": "1",
"groups": "",
"disable_donor_archive": "",
"disable_donor_delete": "",
"disable_donor_restore": "",
"disable_entity_delete": "",
"disable_entity_restore": "",
"disable_message_send_without_approval": "",
"client_id": "207",
"name": "sample",
"group_id": "",
"program-929": "1",
"donor-639": "1"
}
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({
account: '',
admins: '',
donations: '',
email_manager: '',
form_report: '',
forms: '',
disable_entity_archive: '',
manage_designations: '',
manage_email: '',
manage_programs: '',
manage_settings: '',
new_form: '',
group_all: '1',
groups: '',
disable_donor_archive: '',
disable_donor_delete: '',
disable_donor_restore: '',
disable_entity_delete: '',
disable_entity_restore: '',
disable_message_send_without_approval: '',
client_id: '207',
name: 'sample',
group_id: '',
'program-929': '1',
'donor-639': '1'
})
};
fetch('https://api.helpyousponsor.com/v1/admin/groups', 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/groups",
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([
'account' => '',
'admins' => '',
'donations' => '',
'email_manager' => '',
'form_report' => '',
'forms' => '',
'disable_entity_archive' => '',
'manage_designations' => '',
'manage_email' => '',
'manage_programs' => '',
'manage_settings' => '',
'new_form' => '',
'group_all' => '1',
'groups' => '',
'disable_donor_archive' => '',
'disable_donor_delete' => '',
'disable_donor_restore' => '',
'disable_entity_delete' => '',
'disable_entity_restore' => '',
'disable_message_send_without_approval' => '',
'client_id' => '207',
'name' => 'sample',
'group_id' => '',
'program-929' => '1',
'donor-639' => '1'
]),
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/groups"
payload := strings.NewReader("{\n \"account\": \"\",\n \"admins\": \"\",\n \"donations\": \"\",\n \"email_manager\": \"\",\n \"form_report\": \"\",\n \"forms\": \"\",\n \"disable_entity_archive\": \"\",\n \"manage_designations\": \"\",\n \"manage_email\": \"\",\n \"manage_programs\": \"\",\n \"manage_settings\": \"\",\n \"new_form\": \"\",\n \"group_all\": \"1\",\n \"groups\": \"\",\n \"disable_donor_archive\": \"\",\n \"disable_donor_delete\": \"\",\n \"disable_donor_restore\": \"\",\n \"disable_entity_delete\": \"\",\n \"disable_entity_restore\": \"\",\n \"disable_message_send_without_approval\": \"\",\n \"client_id\": \"207\",\n \"name\": \"sample\",\n \"group_id\": \"\",\n \"program-929\": \"1\",\n \"donor-639\": \"1\"\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/groups")
.header("X-HYS-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"account\": \"\",\n \"admins\": \"\",\n \"donations\": \"\",\n \"email_manager\": \"\",\n \"form_report\": \"\",\n \"forms\": \"\",\n \"disable_entity_archive\": \"\",\n \"manage_designations\": \"\",\n \"manage_email\": \"\",\n \"manage_programs\": \"\",\n \"manage_settings\": \"\",\n \"new_form\": \"\",\n \"group_all\": \"1\",\n \"groups\": \"\",\n \"disable_donor_archive\": \"\",\n \"disable_donor_delete\": \"\",\n \"disable_donor_restore\": \"\",\n \"disable_entity_delete\": \"\",\n \"disable_entity_restore\": \"\",\n \"disable_message_send_without_approval\": \"\",\n \"client_id\": \"207\",\n \"name\": \"sample\",\n \"group_id\": \"\",\n \"program-929\": \"1\",\n \"donor-639\": \"1\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helpyousponsor.com/v1/admin/groups")
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 \"account\": \"\",\n \"admins\": \"\",\n \"donations\": \"\",\n \"email_manager\": \"\",\n \"form_report\": \"\",\n \"forms\": \"\",\n \"disable_entity_archive\": \"\",\n \"manage_designations\": \"\",\n \"manage_email\": \"\",\n \"manage_programs\": \"\",\n \"manage_settings\": \"\",\n \"new_form\": \"\",\n \"group_all\": \"1\",\n \"groups\": \"\",\n \"disable_donor_archive\": \"\",\n \"disable_donor_delete\": \"\",\n \"disable_donor_restore\": \"\",\n \"disable_entity_delete\": \"\",\n \"disable_entity_restore\": \"\",\n \"disable_message_send_without_approval\": \"\",\n \"client_id\": \"207\",\n \"name\": \"sample\",\n \"group_id\": \"\",\n \"program-929\": \"1\",\n \"donor-639\": \"1\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Successfully Created Group"
}Authorizations
API key generated from Developer Settings. Format: hys_...
Body
application/json
Group details
Example:
""
Example:
""
Example:
""
Example:
""
Example:
""
Example:
""
Example:
""
Example:
""
Example:
""
Example:
""
Example:
""
Example:
""
Example:
"1"
Example:
""
Example:
""
Example:
""
Example:
""
Example:
""
Example:
""
Example:
""
Example:
"207"
Example:
"sample"
Example:
""
Example:
"1"
Example:
"1"
Response
Successful operation
Example:
"Successfully Created Group"
⌘I
Create a new group
curl --request POST \
--url https://api.helpyousponsor.com/v1/admin/groups \
--header 'Content-Type: application/json' \
--header 'X-HYS-API-Key: <api-key>' \
--data '
{
"account": "",
"admins": "",
"donations": "",
"email_manager": "",
"form_report": "",
"forms": "",
"disable_entity_archive": "",
"manage_designations": "",
"manage_email": "",
"manage_programs": "",
"manage_settings": "",
"new_form": "",
"group_all": "1",
"groups": "",
"disable_donor_archive": "",
"disable_donor_delete": "",
"disable_donor_restore": "",
"disable_entity_delete": "",
"disable_entity_restore": "",
"disable_message_send_without_approval": "",
"client_id": "207",
"name": "sample",
"group_id": "",
"program-929": "1",
"donor-639": "1"
}
'import requests
url = "https://api.helpyousponsor.com/v1/admin/groups"
payload = {
"account": "",
"admins": "",
"donations": "",
"email_manager": "",
"form_report": "",
"forms": "",
"disable_entity_archive": "",
"manage_designations": "",
"manage_email": "",
"manage_programs": "",
"manage_settings": "",
"new_form": "",
"group_all": "1",
"groups": "",
"disable_donor_archive": "",
"disable_donor_delete": "",
"disable_donor_restore": "",
"disable_entity_delete": "",
"disable_entity_restore": "",
"disable_message_send_without_approval": "",
"client_id": "207",
"name": "sample",
"group_id": "",
"program-929": "1",
"donor-639": "1"
}
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({
account: '',
admins: '',
donations: '',
email_manager: '',
form_report: '',
forms: '',
disable_entity_archive: '',
manage_designations: '',
manage_email: '',
manage_programs: '',
manage_settings: '',
new_form: '',
group_all: '1',
groups: '',
disable_donor_archive: '',
disable_donor_delete: '',
disable_donor_restore: '',
disable_entity_delete: '',
disable_entity_restore: '',
disable_message_send_without_approval: '',
client_id: '207',
name: 'sample',
group_id: '',
'program-929': '1',
'donor-639': '1'
})
};
fetch('https://api.helpyousponsor.com/v1/admin/groups', 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/groups",
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([
'account' => '',
'admins' => '',
'donations' => '',
'email_manager' => '',
'form_report' => '',
'forms' => '',
'disable_entity_archive' => '',
'manage_designations' => '',
'manage_email' => '',
'manage_programs' => '',
'manage_settings' => '',
'new_form' => '',
'group_all' => '1',
'groups' => '',
'disable_donor_archive' => '',
'disable_donor_delete' => '',
'disable_donor_restore' => '',
'disable_entity_delete' => '',
'disable_entity_restore' => '',
'disable_message_send_without_approval' => '',
'client_id' => '207',
'name' => 'sample',
'group_id' => '',
'program-929' => '1',
'donor-639' => '1'
]),
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/groups"
payload := strings.NewReader("{\n \"account\": \"\",\n \"admins\": \"\",\n \"donations\": \"\",\n \"email_manager\": \"\",\n \"form_report\": \"\",\n \"forms\": \"\",\n \"disable_entity_archive\": \"\",\n \"manage_designations\": \"\",\n \"manage_email\": \"\",\n \"manage_programs\": \"\",\n \"manage_settings\": \"\",\n \"new_form\": \"\",\n \"group_all\": \"1\",\n \"groups\": \"\",\n \"disable_donor_archive\": \"\",\n \"disable_donor_delete\": \"\",\n \"disable_donor_restore\": \"\",\n \"disable_entity_delete\": \"\",\n \"disable_entity_restore\": \"\",\n \"disable_message_send_without_approval\": \"\",\n \"client_id\": \"207\",\n \"name\": \"sample\",\n \"group_id\": \"\",\n \"program-929\": \"1\",\n \"donor-639\": \"1\"\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/groups")
.header("X-HYS-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"account\": \"\",\n \"admins\": \"\",\n \"donations\": \"\",\n \"email_manager\": \"\",\n \"form_report\": \"\",\n \"forms\": \"\",\n \"disable_entity_archive\": \"\",\n \"manage_designations\": \"\",\n \"manage_email\": \"\",\n \"manage_programs\": \"\",\n \"manage_settings\": \"\",\n \"new_form\": \"\",\n \"group_all\": \"1\",\n \"groups\": \"\",\n \"disable_donor_archive\": \"\",\n \"disable_donor_delete\": \"\",\n \"disable_donor_restore\": \"\",\n \"disable_entity_delete\": \"\",\n \"disable_entity_restore\": \"\",\n \"disable_message_send_without_approval\": \"\",\n \"client_id\": \"207\",\n \"name\": \"sample\",\n \"group_id\": \"\",\n \"program-929\": \"1\",\n \"donor-639\": \"1\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helpyousponsor.com/v1/admin/groups")
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 \"account\": \"\",\n \"admins\": \"\",\n \"donations\": \"\",\n \"email_manager\": \"\",\n \"form_report\": \"\",\n \"forms\": \"\",\n \"disable_entity_archive\": \"\",\n \"manage_designations\": \"\",\n \"manage_email\": \"\",\n \"manage_programs\": \"\",\n \"manage_settings\": \"\",\n \"new_form\": \"\",\n \"group_all\": \"1\",\n \"groups\": \"\",\n \"disable_donor_archive\": \"\",\n \"disable_donor_delete\": \"\",\n \"disable_donor_restore\": \"\",\n \"disable_entity_delete\": \"\",\n \"disable_entity_restore\": \"\",\n \"disable_message_send_without_approval\": \"\",\n \"client_id\": \"207\",\n \"name\": \"sample\",\n \"group_id\": \"\",\n \"program-929\": \"1\",\n \"donor-639\": \"1\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Successfully Created Group"
}
