Queue a bulk file permission update

PATCH

files

permissions

bulk

curl --request PATCH \
  --url https://api.gratona.com/v1/files/permissions/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "permissions": "donor",
  "program_id": 42,
  "upload_ids": [
    815
  ],
  "entity_ids": [
    1001
  ],
  "selection_mode": "search",
  "search_query": "school report",
  "filter_groups": [
    {}
  ],
  "scheduled_date": "2026-06-01",
  "notify_donor": true,
  "include_profile_files": false
}
'

import requests

url = "https://api.gratona.com/v1/files/permissions/bulk"

payload = {
    "permissions": "donor",
    "program_id": 42,
    "upload_ids": [815],
    "entity_ids": [1001],
    "selection_mode": "search",
    "search_query": "school report",
    "filter_groups": [{}],
    "scheduled_date": "2026-06-01",
    "notify_donor": True,
    "include_profile_files": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    permissions: 'donor',
    program_id: 42,
    upload_ids: [815],
    entity_ids: [1001],
    selection_mode: 'search',
    search_query: 'school report',
    filter_groups: [{}],
    scheduled_date: '2026-06-01',
    notify_donor: true,
    include_profile_files: false
  })
};

fetch('https://api.gratona.com/v1/files/permissions/bulk', 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/files/permissions/bulk",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'permissions' => 'donor',
    'program_id' => 42,
    'upload_ids' => [
        815
    ],
    'entity_ids' => [
        1001
    ],
    'selection_mode' => 'search',
    'search_query' => 'school report',
    'filter_groups' => [
        [
                
        ]
    ],
    'scheduled_date' => '2026-06-01',
    'notify_donor' => true,
    'include_profile_files' => false
  ]),
  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/files/permissions/bulk"

	payload := strings.NewReader("{\n  \"permissions\": \"donor\",\n  \"program_id\": 42,\n  \"upload_ids\": [\n    815\n  ],\n  \"entity_ids\": [\n    1001\n  ],\n  \"selection_mode\": \"search\",\n  \"search_query\": \"school report\",\n  \"filter_groups\": [\n    {}\n  ],\n  \"scheduled_date\": \"2026-06-01\",\n  \"notify_donor\": true,\n  \"include_profile_files\": false\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.gratona.com/v1/files/permissions/bulk")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"permissions\": \"donor\",\n  \"program_id\": 42,\n  \"upload_ids\": [\n    815\n  ],\n  \"entity_ids\": [\n    1001\n  ],\n  \"selection_mode\": \"search\",\n  \"search_query\": \"school report\",\n  \"filter_groups\": [\n    {}\n  ],\n  \"scheduled_date\": \"2026-06-01\",\n  \"notify_donor\": true,\n  \"include_profile_files\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/files/permissions/bulk")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"permissions\": \"donor\",\n  \"program_id\": 42,\n  \"upload_ids\": [\n    815\n  ],\n  \"entity_ids\": [\n    1001\n  ],\n  \"selection_mode\": \"search\",\n  \"search_query\": \"school report\",\n  \"filter_groups\": [\n    {}\n  ],\n  \"scheduled_date\": \"2026-06-01\",\n  \"notify_donor\": true,\n  \"include_profile_files\": false\n}"

response = http.request(request)
puts response.read_body

{
  "message": "Your file permission update is being processed in the background."
}

{
  "message": "Unauthorized",
  "status": "error"
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}

Authorizations

Authorization

string

header

required

Passport bearer token authentication for legacy admin sessions.

Body

application/json

permissions

enum<string>

required

Required permission target. public exposes files broadly, donor limits them to related donors and admins, and admin hides them from donors.

Available options:

public,

donor,

admin

Example:

"donor"

program_id

integer | null

Nullable integer. Required when selection_mode is program, search, or advanced_filter so the job can scope files to one program.

Example:

42

upload_ids

integer[] | null

Nullable array of explicit upload IDs to update.

entity_ids

integer[] | null

Nullable array of recipient IDs whose files should be updated.

selection_mode

enum<string> | null

Nullable string. Selects files by program, search query, or advanced filter instead of explicit upload IDs.

Available options:

program,

search,

advanced_filter

Example:

"search"

search_query

string | null

Nullable string. Required when selection_mode is search; passed to the background selector.

Example:

"school report"

filter_groups

object[] | null

Nullable array. Required when selection_mode is advanced_filter; contains the same filter group payload used by the file filter UI.

scheduled_date

string<date> | null

Nullable date. When present, the job schedules the permission change instead of applying it immediately.

Example:

"2026-06-01"

notify_donor

boolean | null

Nullable boolean. When true and permissions become public, donor notification jobs may be dispatched.

Example:

true

include_profile_files

boolean | null

Nullable boolean. When true, profile files can be included in the selected file set.

Example:

false

Response

Bulk permission job queued.

message

string

Example:

"Your file permission update is being processed in the background."

Queue a bulk file permission update

curl --request PATCH \
  --url https://api.gratona.com/v1/files/permissions/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "permissions": "donor",
  "program_id": 42,
  "upload_ids": [
    815
  ],
  "entity_ids": [
    1001
  ],
  "selection_mode": "search",
  "search_query": "school report",
  "filter_groups": [
    {}
  ],
  "scheduled_date": "2026-06-01",
  "notify_donor": true,
  "include_profile_files": false
}
'

import requests

url = "https://api.gratona.com/v1/files/permissions/bulk"

payload = {
    "permissions": "donor",
    "program_id": 42,
    "upload_ids": [815],
    "entity_ids": [1001],
    "selection_mode": "search",
    "search_query": "school report",
    "filter_groups": [{}],
    "scheduled_date": "2026-06-01",
    "notify_donor": True,
    "include_profile_files": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    permissions: 'donor',
    program_id: 42,
    upload_ids: [815],
    entity_ids: [1001],
    selection_mode: 'search',
    search_query: 'school report',
    filter_groups: [{}],
    scheduled_date: '2026-06-01',
    notify_donor: true,
    include_profile_files: false
  })
};

fetch('https://api.gratona.com/v1/files/permissions/bulk', 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/files/permissions/bulk",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'permissions' => 'donor',
    'program_id' => 42,
    'upload_ids' => [
        815
    ],
    'entity_ids' => [
        1001
    ],
    'selection_mode' => 'search',
    'search_query' => 'school report',
    'filter_groups' => [
        [
                
        ]
    ],
    'scheduled_date' => '2026-06-01',
    'notify_donor' => true,
    'include_profile_files' => false
  ]),
  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/files/permissions/bulk"

	payload := strings.NewReader("{\n  \"permissions\": \"donor\",\n  \"program_id\": 42,\n  \"upload_ids\": [\n    815\n  ],\n  \"entity_ids\": [\n    1001\n  ],\n  \"selection_mode\": \"search\",\n  \"search_query\": \"school report\",\n  \"filter_groups\": [\n    {}\n  ],\n  \"scheduled_date\": \"2026-06-01\",\n  \"notify_donor\": true,\n  \"include_profile_files\": false\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.gratona.com/v1/files/permissions/bulk")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"permissions\": \"donor\",\n  \"program_id\": 42,\n  \"upload_ids\": [\n    815\n  ],\n  \"entity_ids\": [\n    1001\n  ],\n  \"selection_mode\": \"search\",\n  \"search_query\": \"school report\",\n  \"filter_groups\": [\n    {}\n  ],\n  \"scheduled_date\": \"2026-06-01\",\n  \"notify_donor\": true,\n  \"include_profile_files\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/files/permissions/bulk")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"permissions\": \"donor\",\n  \"program_id\": 42,\n  \"upload_ids\": [\n    815\n  ],\n  \"entity_ids\": [\n    1001\n  ],\n  \"selection_mode\": \"search\",\n  \"search_query\": \"school report\",\n  \"filter_groups\": [\n    {}\n  ],\n  \"scheduled_date\": \"2026-06-01\",\n  \"notify_donor\": true,\n  \"include_profile_files\": false\n}"

response = http.request(request)
puts response.read_body

{
  "message": "Your file permission update is being processed in the background."
}

{
  "message": "Unauthorized",
  "status": "error"
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}

Overview

Admin

Admin Dashboard

Auth

Client

Communications

Donations

Donor Portal

Donor Signup

Donors

Email Settings

Entities

Files

Forms

Frontend

Historical Archived Updates

Payments

Programs

Public

Recipient Portal

Reports

Sponsorships

Team & Access

Trips

User

Webhooks

Wrapped

Queue a bulk file permission update

Authorizations

Body

Response