Settings
Update restricted record display levels
Partially merges supported record-type levels. Unknown record types and full visibility are rejected. Supply revision to detect concurrent edits; stale revisions return409. No-op writes preserve the revision. Enforcement currently applies to mentions. Requires permission: one of manage_settings.
PUT
/
admin
/
privacy
/
record-disclosure
Update restricted record display levels
curl --request PUT \
--url https://api.gratona.com/v1/admin/privacy/record-disclosure \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"levels": {
"entity": "reference",
"donor": "reference",
"program": "reference",
"event": "reference",
"trip": "reference",
"donation": "reference"
},
"revision": 0
}
'import requests
url = "https://api.gratona.com/v1/admin/privacy/record-disclosure"
payload = {
"levels": {
"entity": "reference",
"donor": "reference",
"program": "reference",
"event": "reference",
"trip": "reference",
"donation": "reference"
},
"revision": 0
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
levels: {
entity: 'reference',
donor: 'reference',
program: 'reference',
event: 'reference',
trip: 'reference',
donation: 'reference'
},
revision: 0
})
};
fetch('https://api.gratona.com/v1/admin/privacy/record-disclosure', 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/privacy/record-disclosure",
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([
'levels' => [
'entity' => 'reference',
'donor' => 'reference',
'program' => 'reference',
'event' => 'reference',
'trip' => 'reference',
'donation' => 'reference'
],
'revision' => 0
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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/privacy/record-disclosure"
payload := strings.NewReader("{\n \"levels\": {\n \"entity\": \"reference\",\n \"donor\": \"reference\",\n \"program\": \"reference\",\n \"event\": \"reference\",\n \"trip\": \"reference\",\n \"donation\": \"reference\"\n },\n \"revision\": 0\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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/privacy/record-disclosure")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"levels\": {\n \"entity\": \"reference\",\n \"donor\": \"reference\",\n \"program\": \"reference\",\n \"event\": \"reference\",\n \"trip\": \"reference\",\n \"donation\": \"reference\"\n },\n \"revision\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/privacy/record-disclosure")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"levels\": {\n \"entity\": \"reference\",\n \"donor\": \"reference\",\n \"program\": \"reference\",\n \"event\": \"reference\",\n \"trip\": \"reference\",\n \"donation\": \"reference\"\n },\n \"revision\": 0\n}"
response = http.request(request)
puts response.read_body{
"data": {
"levels": {
"entity": "reference",
"donor": "reference",
"program": "reference",
"event": "reference",
"trip": "reference",
"donation": "reference"
},
"defaults": {
"entity": "reference",
"donor": "reference",
"program": "reference",
"event": "reference",
"trip": "reference",
"donation": "reference"
},
"revision": 0,
"types": [
{
"key": "donor",
"label": "Donors",
"default": "first_initial",
"configurable": true,
"composed": false
}
],
"ladder": [
{
"key": "reference",
"rank": 2,
"label": "Reference ID",
"description": "The organisation reference number or record number.",
"configurable": true
}
],
"program_overrides": [
{
"program_id": 42,
"program_name": "Education",
"entity_level": "reference",
"hide_program_type": false,
"effective_entity_level": "reference",
"revision": 0
}
],
"enforced_surfaces": [
"mentions"
]
}
}{
"message": "Unauthorized",
"status": "error"
}{
"errors": {},
"status": "error",
"message": "The given data was invalid."
}Authorizations
bearerAuthapiKeyAuth
Passport bearer token authentication for legacy admin sessions.
Body
application/json
Validated request fields for this operation.
Response
Operation result.
Show child attributes
Show child attributes
⌘I
Update restricted record display levels
curl --request PUT \
--url https://api.gratona.com/v1/admin/privacy/record-disclosure \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"levels": {
"entity": "reference",
"donor": "reference",
"program": "reference",
"event": "reference",
"trip": "reference",
"donation": "reference"
},
"revision": 0
}
'import requests
url = "https://api.gratona.com/v1/admin/privacy/record-disclosure"
payload = {
"levels": {
"entity": "reference",
"donor": "reference",
"program": "reference",
"event": "reference",
"trip": "reference",
"donation": "reference"
},
"revision": 0
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
levels: {
entity: 'reference',
donor: 'reference',
program: 'reference',
event: 'reference',
trip: 'reference',
donation: 'reference'
},
revision: 0
})
};
fetch('https://api.gratona.com/v1/admin/privacy/record-disclosure', 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/privacy/record-disclosure",
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([
'levels' => [
'entity' => 'reference',
'donor' => 'reference',
'program' => 'reference',
'event' => 'reference',
'trip' => 'reference',
'donation' => 'reference'
],
'revision' => 0
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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/privacy/record-disclosure"
payload := strings.NewReader("{\n \"levels\": {\n \"entity\": \"reference\",\n \"donor\": \"reference\",\n \"program\": \"reference\",\n \"event\": \"reference\",\n \"trip\": \"reference\",\n \"donation\": \"reference\"\n },\n \"revision\": 0\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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/privacy/record-disclosure")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"levels\": {\n \"entity\": \"reference\",\n \"donor\": \"reference\",\n \"program\": \"reference\",\n \"event\": \"reference\",\n \"trip\": \"reference\",\n \"donation\": \"reference\"\n },\n \"revision\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/privacy/record-disclosure")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"levels\": {\n \"entity\": \"reference\",\n \"donor\": \"reference\",\n \"program\": \"reference\",\n \"event\": \"reference\",\n \"trip\": \"reference\",\n \"donation\": \"reference\"\n },\n \"revision\": 0\n}"
response = http.request(request)
puts response.read_body{
"data": {
"levels": {
"entity": "reference",
"donor": "reference",
"program": "reference",
"event": "reference",
"trip": "reference",
"donation": "reference"
},
"defaults": {
"entity": "reference",
"donor": "reference",
"program": "reference",
"event": "reference",
"trip": "reference",
"donation": "reference"
},
"revision": 0,
"types": [
{
"key": "donor",
"label": "Donors",
"default": "first_initial",
"configurable": true,
"composed": false
}
],
"ladder": [
{
"key": "reference",
"rank": 2,
"label": "Reference ID",
"description": "The organisation reference number or record number.",
"configurable": true
}
],
"program_overrides": [
{
"program_id": 42,
"program_name": "Education",
"entity_level": "reference",
"hide_program_type": false,
"effective_entity_level": "reference",
"revision": 0
}
],
"enforced_surfaces": [
"mentions"
]
}
}{
"message": "Unauthorized",
"status": "error"
}{
"errors": {},
"status": "error",
"message": "The given data was invalid."
}