Team & Access
Edit a specific Access role
PUT
/
admin
/
groups
/
{group_id}
Edit a specific Access role
curl --request PUT \
--url https://api.gratona.com/v1/admin/groups/{group_id} \
--header 'Content-Type: application/json' \
--header 'X-HYS-API-Key: <api-key>' \
--data '
{
"id": 301,
"name": "Gratona Demos",
"client_id": "207",
"group_all": "1",
"account": "1",
"groups": "1",
"group-{group_id}": "1",
"admins": "1",
"forms": "1",
"new_form": "1",
"manage_programs": "1",
"manage_settings": "1",
"manage_designations": "1",
"manage_email": "1",
"email_manager": "1",
"donations": "1",
"form_report": "1",
"program-{program_id}": "1",
"donor-{donor_id}": "1",
"program-all": "1",
"donor-all": "1",
"disable_entity_archive": "1",
"disable_sponsorship_archive": null,
"disable_sponsorship_restore": null,
"disable_donor_archive": null,
"disable_donor_delete": null,
"disable_donor_restore": null,
"disable_entity_delete": null,
"disable_entity_restore": null,
"group_id": 301,
"disable_message_send_without_approval": null
}
'import requests
url = "https://api.gratona.com/v1/admin/groups/{group_id}"
payload = {
"id": 301,
"name": "Gratona Demos",
"client_id": "207",
"group_all": "1",
"account": "1",
"groups": "1",
"group-{group_id}": "1",
"admins": "1",
"forms": "1",
"new_form": "1",
"manage_programs": "1",
"manage_settings": "1",
"manage_designations": "1",
"manage_email": "1",
"email_manager": "1",
"donations": "1",
"form_report": "1",
"program-{program_id}": "1",
"donor-{donor_id}": "1",
"program-all": "1",
"donor-all": "1",
"disable_entity_archive": "1",
"disable_sponsorship_archive": None,
"disable_sponsorship_restore": None,
"disable_donor_archive": None,
"disable_donor_delete": None,
"disable_donor_restore": None,
"disable_entity_delete": None,
"disable_entity_restore": None,
"group_id": 301,
"disable_message_send_without_approval": None
}
headers = {
"X-HYS-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-HYS-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: 301,
name: 'Gratona Demos',
client_id: '207',
group_all: '1',
account: '1',
groups: '1',
'group-{group_id}': '1',
admins: '1',
forms: '1',
new_form: '1',
manage_programs: '1',
manage_settings: '1',
manage_designations: '1',
manage_email: '1',
email_manager: '1',
donations: '1',
form_report: '1',
'program-{program_id}': '1',
'donor-{donor_id}': '1',
'program-all': '1',
'donor-all': '1',
disable_entity_archive: '1',
disable_sponsorship_archive: null,
disable_sponsorship_restore: null,
disable_donor_archive: null,
disable_donor_delete: null,
disable_donor_restore: null,
disable_entity_delete: null,
disable_entity_restore: null,
group_id: 301,
disable_message_send_without_approval: null
})
};
fetch('https://api.gratona.com/v1/admin/groups/{group_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.gratona.com/v1/admin/groups/{group_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'id' => 301,
'name' => 'Gratona Demos',
'client_id' => '207',
'group_all' => '1',
'account' => '1',
'groups' => '1',
'group-{group_id}' => '1',
'admins' => '1',
'forms' => '1',
'new_form' => '1',
'manage_programs' => '1',
'manage_settings' => '1',
'manage_designations' => '1',
'manage_email' => '1',
'email_manager' => '1',
'donations' => '1',
'form_report' => '1',
'program-{program_id}' => '1',
'donor-{donor_id}' => '1',
'program-all' => '1',
'donor-all' => '1',
'disable_entity_archive' => '1',
'disable_sponsorship_archive' => null,
'disable_sponsorship_restore' => null,
'disable_donor_archive' => null,
'disable_donor_delete' => null,
'disable_donor_restore' => null,
'disable_entity_delete' => null,
'disable_entity_restore' => null,
'group_id' => 301,
'disable_message_send_without_approval' => null
]),
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.gratona.com/v1/admin/groups/{group_id}"
payload := strings.NewReader("{\n \"id\": 301,\n \"name\": \"Gratona Demos\",\n \"client_id\": \"207\",\n \"group_all\": \"1\",\n \"account\": \"1\",\n \"groups\": \"1\",\n \"group-{group_id}\": \"1\",\n \"admins\": \"1\",\n \"forms\": \"1\",\n \"new_form\": \"1\",\n \"manage_programs\": \"1\",\n \"manage_settings\": \"1\",\n \"manage_designations\": \"1\",\n \"manage_email\": \"1\",\n \"email_manager\": \"1\",\n \"donations\": \"1\",\n \"form_report\": \"1\",\n \"program-{program_id}\": \"1\",\n \"donor-{donor_id}\": \"1\",\n \"program-all\": \"1\",\n \"donor-all\": \"1\",\n \"disable_entity_archive\": \"1\",\n \"disable_sponsorship_archive\": null,\n \"disable_sponsorship_restore\": null,\n \"disable_donor_archive\": null,\n \"disable_donor_delete\": null,\n \"disable_donor_restore\": null,\n \"disable_entity_delete\": null,\n \"disable_entity_restore\": null,\n \"group_id\": 301,\n \"disable_message_send_without_approval\": null\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.gratona.com/v1/admin/groups/{group_id}")
.header("X-HYS-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": 301,\n \"name\": \"Gratona Demos\",\n \"client_id\": \"207\",\n \"group_all\": \"1\",\n \"account\": \"1\",\n \"groups\": \"1\",\n \"group-{group_id}\": \"1\",\n \"admins\": \"1\",\n \"forms\": \"1\",\n \"new_form\": \"1\",\n \"manage_programs\": \"1\",\n \"manage_settings\": \"1\",\n \"manage_designations\": \"1\",\n \"manage_email\": \"1\",\n \"email_manager\": \"1\",\n \"donations\": \"1\",\n \"form_report\": \"1\",\n \"program-{program_id}\": \"1\",\n \"donor-{donor_id}\": \"1\",\n \"program-all\": \"1\",\n \"donor-all\": \"1\",\n \"disable_entity_archive\": \"1\",\n \"disable_sponsorship_archive\": null,\n \"disable_sponsorship_restore\": null,\n \"disable_donor_archive\": null,\n \"disable_donor_delete\": null,\n \"disable_donor_restore\": null,\n \"disable_entity_delete\": null,\n \"disable_entity_restore\": null,\n \"group_id\": 301,\n \"disable_message_send_without_approval\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/groups/{group_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-HYS-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": 301,\n \"name\": \"Gratona Demos\",\n \"client_id\": \"207\",\n \"group_all\": \"1\",\n \"account\": \"1\",\n \"groups\": \"1\",\n \"group-{group_id}\": \"1\",\n \"admins\": \"1\",\n \"forms\": \"1\",\n \"new_form\": \"1\",\n \"manage_programs\": \"1\",\n \"manage_settings\": \"1\",\n \"manage_designations\": \"1\",\n \"manage_email\": \"1\",\n \"email_manager\": \"1\",\n \"donations\": \"1\",\n \"form_report\": \"1\",\n \"program-{program_id}\": \"1\",\n \"donor-{donor_id}\": \"1\",\n \"program-all\": \"1\",\n \"donor-all\": \"1\",\n \"disable_entity_archive\": \"1\",\n \"disable_sponsorship_archive\": null,\n \"disable_sponsorship_restore\": null,\n \"disable_donor_archive\": null,\n \"disable_donor_delete\": null,\n \"disable_donor_restore\": null,\n \"disable_entity_delete\": null,\n \"disable_entity_restore\": null,\n \"group_id\": 301,\n \"disable_message_send_without_approval\": null\n}"
response = http.request(request)
puts response.read_body{
"message": "Access role updated"
}{
"message": "Validation failed",
"errors": {}
}Authorizations
apiKeyAuthbearerAuth
Gratona API key sent with the compatibility header X-HYS-API-Key.
Path Parameters
ID of the group to edit
Body
application/json
The ID of the Access role
Example:
301
The name of the Access role
Example:
"Gratona Demos"
Example:
"207"
Example:
"1"
Example:
"1"
Example:
"1"
Example:
"1"
Example:
"1"
Example:
"1"
Example:
"1"
Example:
"1"
Example:
"1"
Example:
"1"
Example:
"1"
Example:
"1"
Example:
"1"
Example:
"1"
Example:
"1"
Example:
"1"
Example:
"1"
Example:
"1"
Example:
"1"
Example:
null
Example:
null
Example:
null
Example:
null
Example:
null
Example:
null
Example:
null
The Access role ID
Example:
301
Example:
null
Response
Successfully Updated the Group
Example:
"Access role updated"
⌘I
Edit a specific Access role
curl --request PUT \
--url https://api.gratona.com/v1/admin/groups/{group_id} \
--header 'Content-Type: application/json' \
--header 'X-HYS-API-Key: <api-key>' \
--data '
{
"id": 301,
"name": "Gratona Demos",
"client_id": "207",
"group_all": "1",
"account": "1",
"groups": "1",
"group-{group_id}": "1",
"admins": "1",
"forms": "1",
"new_form": "1",
"manage_programs": "1",
"manage_settings": "1",
"manage_designations": "1",
"manage_email": "1",
"email_manager": "1",
"donations": "1",
"form_report": "1",
"program-{program_id}": "1",
"donor-{donor_id}": "1",
"program-all": "1",
"donor-all": "1",
"disable_entity_archive": "1",
"disable_sponsorship_archive": null,
"disable_sponsorship_restore": null,
"disable_donor_archive": null,
"disable_donor_delete": null,
"disable_donor_restore": null,
"disable_entity_delete": null,
"disable_entity_restore": null,
"group_id": 301,
"disable_message_send_without_approval": null
}
'import requests
url = "https://api.gratona.com/v1/admin/groups/{group_id}"
payload = {
"id": 301,
"name": "Gratona Demos",
"client_id": "207",
"group_all": "1",
"account": "1",
"groups": "1",
"group-{group_id}": "1",
"admins": "1",
"forms": "1",
"new_form": "1",
"manage_programs": "1",
"manage_settings": "1",
"manage_designations": "1",
"manage_email": "1",
"email_manager": "1",
"donations": "1",
"form_report": "1",
"program-{program_id}": "1",
"donor-{donor_id}": "1",
"program-all": "1",
"donor-all": "1",
"disable_entity_archive": "1",
"disable_sponsorship_archive": None,
"disable_sponsorship_restore": None,
"disable_donor_archive": None,
"disable_donor_delete": None,
"disable_donor_restore": None,
"disable_entity_delete": None,
"disable_entity_restore": None,
"group_id": 301,
"disable_message_send_without_approval": None
}
headers = {
"X-HYS-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-HYS-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: 301,
name: 'Gratona Demos',
client_id: '207',
group_all: '1',
account: '1',
groups: '1',
'group-{group_id}': '1',
admins: '1',
forms: '1',
new_form: '1',
manage_programs: '1',
manage_settings: '1',
manage_designations: '1',
manage_email: '1',
email_manager: '1',
donations: '1',
form_report: '1',
'program-{program_id}': '1',
'donor-{donor_id}': '1',
'program-all': '1',
'donor-all': '1',
disable_entity_archive: '1',
disable_sponsorship_archive: null,
disable_sponsorship_restore: null,
disable_donor_archive: null,
disable_donor_delete: null,
disable_donor_restore: null,
disable_entity_delete: null,
disable_entity_restore: null,
group_id: 301,
disable_message_send_without_approval: null
})
};
fetch('https://api.gratona.com/v1/admin/groups/{group_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.gratona.com/v1/admin/groups/{group_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'id' => 301,
'name' => 'Gratona Demos',
'client_id' => '207',
'group_all' => '1',
'account' => '1',
'groups' => '1',
'group-{group_id}' => '1',
'admins' => '1',
'forms' => '1',
'new_form' => '1',
'manage_programs' => '1',
'manage_settings' => '1',
'manage_designations' => '1',
'manage_email' => '1',
'email_manager' => '1',
'donations' => '1',
'form_report' => '1',
'program-{program_id}' => '1',
'donor-{donor_id}' => '1',
'program-all' => '1',
'donor-all' => '1',
'disable_entity_archive' => '1',
'disable_sponsorship_archive' => null,
'disable_sponsorship_restore' => null,
'disable_donor_archive' => null,
'disable_donor_delete' => null,
'disable_donor_restore' => null,
'disable_entity_delete' => null,
'disable_entity_restore' => null,
'group_id' => 301,
'disable_message_send_without_approval' => null
]),
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.gratona.com/v1/admin/groups/{group_id}"
payload := strings.NewReader("{\n \"id\": 301,\n \"name\": \"Gratona Demos\",\n \"client_id\": \"207\",\n \"group_all\": \"1\",\n \"account\": \"1\",\n \"groups\": \"1\",\n \"group-{group_id}\": \"1\",\n \"admins\": \"1\",\n \"forms\": \"1\",\n \"new_form\": \"1\",\n \"manage_programs\": \"1\",\n \"manage_settings\": \"1\",\n \"manage_designations\": \"1\",\n \"manage_email\": \"1\",\n \"email_manager\": \"1\",\n \"donations\": \"1\",\n \"form_report\": \"1\",\n \"program-{program_id}\": \"1\",\n \"donor-{donor_id}\": \"1\",\n \"program-all\": \"1\",\n \"donor-all\": \"1\",\n \"disable_entity_archive\": \"1\",\n \"disable_sponsorship_archive\": null,\n \"disable_sponsorship_restore\": null,\n \"disable_donor_archive\": null,\n \"disable_donor_delete\": null,\n \"disable_donor_restore\": null,\n \"disable_entity_delete\": null,\n \"disable_entity_restore\": null,\n \"group_id\": 301,\n \"disable_message_send_without_approval\": null\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.gratona.com/v1/admin/groups/{group_id}")
.header("X-HYS-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": 301,\n \"name\": \"Gratona Demos\",\n \"client_id\": \"207\",\n \"group_all\": \"1\",\n \"account\": \"1\",\n \"groups\": \"1\",\n \"group-{group_id}\": \"1\",\n \"admins\": \"1\",\n \"forms\": \"1\",\n \"new_form\": \"1\",\n \"manage_programs\": \"1\",\n \"manage_settings\": \"1\",\n \"manage_designations\": \"1\",\n \"manage_email\": \"1\",\n \"email_manager\": \"1\",\n \"donations\": \"1\",\n \"form_report\": \"1\",\n \"program-{program_id}\": \"1\",\n \"donor-{donor_id}\": \"1\",\n \"program-all\": \"1\",\n \"donor-all\": \"1\",\n \"disable_entity_archive\": \"1\",\n \"disable_sponsorship_archive\": null,\n \"disable_sponsorship_restore\": null,\n \"disable_donor_archive\": null,\n \"disable_donor_delete\": null,\n \"disable_donor_restore\": null,\n \"disable_entity_delete\": null,\n \"disable_entity_restore\": null,\n \"group_id\": 301,\n \"disable_message_send_without_approval\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/groups/{group_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-HYS-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": 301,\n \"name\": \"Gratona Demos\",\n \"client_id\": \"207\",\n \"group_all\": \"1\",\n \"account\": \"1\",\n \"groups\": \"1\",\n \"group-{group_id}\": \"1\",\n \"admins\": \"1\",\n \"forms\": \"1\",\n \"new_form\": \"1\",\n \"manage_programs\": \"1\",\n \"manage_settings\": \"1\",\n \"manage_designations\": \"1\",\n \"manage_email\": \"1\",\n \"email_manager\": \"1\",\n \"donations\": \"1\",\n \"form_report\": \"1\",\n \"program-{program_id}\": \"1\",\n \"donor-{donor_id}\": \"1\",\n \"program-all\": \"1\",\n \"donor-all\": \"1\",\n \"disable_entity_archive\": \"1\",\n \"disable_sponsorship_archive\": null,\n \"disable_sponsorship_restore\": null,\n \"disable_donor_archive\": null,\n \"disable_donor_delete\": null,\n \"disable_donor_restore\": null,\n \"disable_entity_delete\": null,\n \"disable_entity_restore\": null,\n \"group_id\": 301,\n \"disable_message_send_without_approval\": null\n}"
response = http.request(request)
puts response.read_body{
"message": "Access role updated"
}{
"message": "Validation failed",
"errors": {}
}