Spaces
Change clearance for files in a space
Requires the spaces feature and current access to the organization, program or recipient. File, story and supporter sections additionally follow their own permissions. Support sessions are read-only. Each file is authorized independently; refused changes are returned as unchanged rows. A successful batch can return a single-use undo token bound to this user and space, valid for sixty seconds.
POST
/
admin
/
spaces
/
{type}
/
{id}
/
clearance
Change clearance for files in a space
curl --request POST \
--url https://api.gratona.com/v1/admin/spaces/{type}/{id}/clearance \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"changes": [
{
"file_ref": "<string>"
}
]
}
'import requests
url = "https://api.gratona.com/v1/admin/spaces/{type}/{id}/clearance"
payload = { "changes": [{ "file_ref": "<string>" }] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({changes: [{file_ref: '<string>'}]})
};
fetch('https://api.gratona.com/v1/admin/spaces/{type}/{id}/clearance', 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/spaces/{type}/{id}/clearance",
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([
'changes' => [
[
'file_ref' => '<string>'
]
]
]),
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/spaces/{type}/{id}/clearance"
payload := strings.NewReader("{\n \"changes\": [\n {\n \"file_ref\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.gratona.com/v1/admin/spaces/{type}/{id}/clearance")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"changes\": [\n {\n \"file_ref\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/spaces/{type}/{id}/clearance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"changes\": [\n {\n \"file_ref\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"file_ref": "<string>",
"changed": true,
"previous_level": "<string>",
"level": "<string>",
"reason": "<string>",
"message": "<string>",
"audiences": {
"supporters": {
"allowed": true,
"reason": "<string>",
"variant": "<string>",
"consent_expires_at": "2023-11-07T05:31:56Z"
},
"public": {
"allowed": true,
"reason": "<string>",
"variant": "<string>",
"consent_expires_at": "2023-11-07T05:31:56Z"
}
}
}
],
"meta": {
"changed": 123,
"unchanged": 123
},
"undo_token": "<string>"
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "Something went wrong. Please try again.",
"status": "error",
"error": "invalid_request",
"code": "DONOR_NOT_FOUND"
}{
"message": "Not Found",
"status": "error"
}{
"errors": {},
"status": "error",
"message": "The given data was invalid."
}Authorizations
bearerAuthapiKeyAuth
Passport bearer token authentication for legacy admin sessions.
Path Parameters
Type.
Available options:
organization, program, recipient Record ID within the organization and any parent resource in this route.
Body
application/json
Request fields accepted by this operation. Omitted optional properties retain the behavior described above.
Required array length:
1 - 200 elementsShow child attributes
Show child attributes
⌘I
Change clearance for files in a space
curl --request POST \
--url https://api.gratona.com/v1/admin/spaces/{type}/{id}/clearance \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"changes": [
{
"file_ref": "<string>"
}
]
}
'import requests
url = "https://api.gratona.com/v1/admin/spaces/{type}/{id}/clearance"
payload = { "changes": [{ "file_ref": "<string>" }] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({changes: [{file_ref: '<string>'}]})
};
fetch('https://api.gratona.com/v1/admin/spaces/{type}/{id}/clearance', 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/spaces/{type}/{id}/clearance",
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([
'changes' => [
[
'file_ref' => '<string>'
]
]
]),
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/spaces/{type}/{id}/clearance"
payload := strings.NewReader("{\n \"changes\": [\n {\n \"file_ref\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.gratona.com/v1/admin/spaces/{type}/{id}/clearance")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"changes\": [\n {\n \"file_ref\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/spaces/{type}/{id}/clearance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"changes\": [\n {\n \"file_ref\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"file_ref": "<string>",
"changed": true,
"previous_level": "<string>",
"level": "<string>",
"reason": "<string>",
"message": "<string>",
"audiences": {
"supporters": {
"allowed": true,
"reason": "<string>",
"variant": "<string>",
"consent_expires_at": "2023-11-07T05:31:56Z"
},
"public": {
"allowed": true,
"reason": "<string>",
"variant": "<string>",
"consent_expires_at": "2023-11-07T05:31:56Z"
}
}
}
],
"meta": {
"changed": 123,
"unchanged": 123
},
"undo_token": "<string>"
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "Something went wrong. Please try again.",
"status": "error",
"error": "invalid_request",
"code": "DONOR_NOT_FOUND"
}{
"message": "Not Found",
"status": "error"
}{
"errors": {},
"status": "error",
"message": "The given data was invalid."
}