Restore selected archived sponsorships

POST

admin

sponsorships

restore

curl --request POST \
  --url https://api.gratona.com/v1/admin/sponsorships/restore \
  --header 'Content-Type: application/json' \
  --header 'X-HYS-API-Key: <api-key>' \
  --data '
{
  "donor_entity_ids": [
    4812,
    4813
  ],
  "next_action_date": "2026-08-01",
  "force_restore": true,
  "preview_token": "eyJpdiI6Ik...",
  "program_id": 17,
  "selection_mode": "selected_rows",
  "filter": "true",
  "query": "Taylor",
  "status": "current",
  "filterGroups": [
    {}
  ],
  "savedFilterId": 42,
  "fields": [
    "donor_id",
    "entity_id"
  ],
  "column_order": [
    "entity_id",
    "donor_id"
  ]
}
'

import requests

url = "https://api.gratona.com/v1/admin/sponsorships/restore"

payload = {
    "donor_entity_ids": [4812, 4813],
    "next_action_date": "2026-08-01",
    "force_restore": True,
    "preview_token": "eyJpdiI6Ik...",
    "program_id": 17,
    "selection_mode": "selected_rows",
    "filter": "true",
    "query": "Taylor",
    "status": "current",
    "filterGroups": [{}],
    "savedFilterId": 42,
    "fields": ["donor_id", "entity_id"],
    "column_order": ["entity_id", "donor_id"]
}
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({
    donor_entity_ids: [4812, 4813],
    next_action_date: '2026-08-01',
    force_restore: true,
    preview_token: 'eyJpdiI6Ik...',
    program_id: 17,
    selection_mode: 'selected_rows',
    filter: 'true',
    query: 'Taylor',
    status: 'current',
    filterGroups: [{}],
    savedFilterId: 42,
    fields: ['donor_id', 'entity_id'],
    column_order: ['entity_id', 'donor_id']
  })
};

fetch('https://api.gratona.com/v1/admin/sponsorships/restore', 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/sponsorships/restore",
  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([
    'donor_entity_ids' => [
        4812,
        4813
    ],
    'next_action_date' => '2026-08-01',
    'force_restore' => true,
    'preview_token' => 'eyJpdiI6Ik...',
    'program_id' => 17,
    'selection_mode' => 'selected_rows',
    'filter' => 'true',
    'query' => 'Taylor',
    'status' => 'current',
    'filterGroups' => [
        [
                
        ]
    ],
    'savedFilterId' => 42,
    'fields' => [
        'donor_id',
        'entity_id'
    ],
    'column_order' => [
        'entity_id',
        'donor_id'
    ]
  ]),
  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/sponsorships/restore"

	payload := strings.NewReader("{\n  \"donor_entity_ids\": [\n    4812,\n    4813\n  ],\n  \"next_action_date\": \"2026-08-01\",\n  \"force_restore\": true,\n  \"preview_token\": \"eyJpdiI6Ik...\",\n  \"program_id\": 17,\n  \"selection_mode\": \"selected_rows\",\n  \"filter\": \"true\",\n  \"query\": \"Taylor\",\n  \"status\": \"current\",\n  \"filterGroups\": [\n    {}\n  ],\n  \"savedFilterId\": 42,\n  \"fields\": [\n    \"donor_id\",\n    \"entity_id\"\n  ],\n  \"column_order\": [\n    \"entity_id\",\n    \"donor_id\"\n  ]\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.gratona.com/v1/admin/sponsorships/restore")
  .header("X-HYS-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"donor_entity_ids\": [\n    4812,\n    4813\n  ],\n  \"next_action_date\": \"2026-08-01\",\n  \"force_restore\": true,\n  \"preview_token\": \"eyJpdiI6Ik...\",\n  \"program_id\": 17,\n  \"selection_mode\": \"selected_rows\",\n  \"filter\": \"true\",\n  \"query\": \"Taylor\",\n  \"status\": \"current\",\n  \"filterGroups\": [\n    {}\n  ],\n  \"savedFilterId\": 42,\n  \"fields\": [\n    \"donor_id\",\n    \"entity_id\"\n  ],\n  \"column_order\": [\n    \"entity_id\",\n    \"donor_id\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/admin/sponsorships/restore")

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  \"donor_entity_ids\": [\n    4812,\n    4813\n  ],\n  \"next_action_date\": \"2026-08-01\",\n  \"force_restore\": true,\n  \"preview_token\": \"eyJpdiI6Ik...\",\n  \"program_id\": 17,\n  \"selection_mode\": \"selected_rows\",\n  \"filter\": \"true\",\n  \"query\": \"Taylor\",\n  \"status\": \"current\",\n  \"filterGroups\": [\n    {}\n  ],\n  \"savedFilterId\": 42,\n  \"fields\": [\n    \"donor_id\",\n    \"entity_id\"\n  ],\n  \"column_order\": [\n    \"entity_id\",\n    \"donor_id\"\n  ]\n}"

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

{
  "message": "Sponsorships Successfully Restored.",
  "restored_count": 2,
  "skipped_count": 1,
  "skipped_ids": [
    4814
  ],
  "skipped": [
    {
      "donor_entity_id": 4814,
      "reason": "donor_inactive"
    }
  ]
}

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

{
  "message": "Something went wrong. Please try again.",
  "status": "error",
  "error": "invalid_request",
  "code": "DONOR_NOT_FOUND"
}

{
  "message": "No archived sponsorships could be restored.",
  "skipped_count": 2,
  "skipped_ids": [
    4812,
    4813
  ],
  "skipped": [
    {
      "donor_entity_id": 4812,
      "reason": "not_archived_or_not_owned"
    }
  ]
}

{
  "message": "One or more recipients are already fully sponsored.",
  "error_code": "RECIPIENT_FULLY_SPONSORED",
  "conflicts": [
    {}
  ]
}

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

Authorizations

X-HYS-API-Key

string

header

required

Gratona API key sent with the compatibility header X-HYS-API-Key.

Body

application/json

Sponsorship table selection and the date used to resume commitment processing.

donor_entity_ids

required

A non-empty list of positive archived sponsorship relationship IDs, or the exact string all to resolve every row in the supplied tenant-scoped table selection. Explicit lists and resolved selections are limited to 250 relationships per synchronous restore.

Required array length: 1 - 250 elements

Required range: x >= 1

Example:

[4812, 4813]

next_action_date

string<date> | null

Date when restored commitments should next be processed. Validation: nullable|date_format:Y-m-d; when omitted, each commitment's existing schedule date is preserved.

Example:

"2026-08-01"

force_restore

boolean | null

Explicitly confirms restoration for all selected recipients already at capacity or projected to exceed capacity by the selected restore.

Example:

true

preview_token

string

Short-lived token binding the mutation to the exact resolved selection and billing state. Required while sponsorship lifecycle controls are enabled.

Example:

"eyJpdiI6Ik..."

program_id

Program ID that scopes an all selection, or all for every accessible program.

Example:

17

selection_mode

enum<string> | null

Indicates whether IDs were selected explicitly or represent every filtered table result.

Available options:

selected_rows,

all_total

Example:

"selected_rows"

filter

enum<string> | null

Archived-table marker. Use true when resolving an all selection so only soft-deleted sponsorships are restored.

Available options:

true

Example:

"true"

query

string | null

Current sponsorship-table search query used when resolving an all selection.

Example:

"Taylor"

status

enum<string> | null

Optional active commitment status filter retained for compatibility with table selections.

Available options:

current,

due

Example:

"current"

filterGroups

object[] | null

Advanced sponsorship filter groups used to resolve an all selection.

savedFilterId

integer | null

Saved sponsorship filter whose criteria should scope an all selection.

Example:

42

fields

string[] | null

Visible sponsorship fields forwarded to filtered selection resolution.

Example:

["donor_id", "entity_id"]

column_order

string[] | null

Current sponsorship worksheet column order forwarded to filtered selection resolution.

Example:

["entity_id", "donor_id"]

Response

One or more sponsorships were restored.

message

string

Human-readable restoration result.

Example:

"Sponsorships Successfully Restored."

restored_count

integer

Number of tenant-owned archived sponsorships restored.

Example:

2

skipped_count

integer

Number of selected IDs skipped because they were invalid, active, cross-tenant, or linked to an archived donor or recipient.

Example:

1

skipped_ids

integer<int64>[]

Selected relationship IDs that were not restored.

Example:

[4814]

skipped

object[]

Per-ID skip details. Reasons include invalid_id, not_archived_or_not_owned, donor_inactive, recipient_inactive, and did_not_remain_active.

Show child attributes

Restore selected archived sponsorships

curl --request POST \
  --url https://api.gratona.com/v1/admin/sponsorships/restore \
  --header 'Content-Type: application/json' \
  --header 'X-HYS-API-Key: <api-key>' \
  --data '
{
  "donor_entity_ids": [
    4812,
    4813
  ],
  "next_action_date": "2026-08-01",
  "force_restore": true,
  "preview_token": "eyJpdiI6Ik...",
  "program_id": 17,
  "selection_mode": "selected_rows",
  "filter": "true",
  "query": "Taylor",
  "status": "current",
  "filterGroups": [
    {}
  ],
  "savedFilterId": 42,
  "fields": [
    "donor_id",
    "entity_id"
  ],
  "column_order": [
    "entity_id",
    "donor_id"
  ]
}
'

import requests

url = "https://api.gratona.com/v1/admin/sponsorships/restore"

payload = {
    "donor_entity_ids": [4812, 4813],
    "next_action_date": "2026-08-01",
    "force_restore": True,
    "preview_token": "eyJpdiI6Ik...",
    "program_id": 17,
    "selection_mode": "selected_rows",
    "filter": "true",
    "query": "Taylor",
    "status": "current",
    "filterGroups": [{}],
    "savedFilterId": 42,
    "fields": ["donor_id", "entity_id"],
    "column_order": ["entity_id", "donor_id"]
}
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({
    donor_entity_ids: [4812, 4813],
    next_action_date: '2026-08-01',
    force_restore: true,
    preview_token: 'eyJpdiI6Ik...',
    program_id: 17,
    selection_mode: 'selected_rows',
    filter: 'true',
    query: 'Taylor',
    status: 'current',
    filterGroups: [{}],
    savedFilterId: 42,
    fields: ['donor_id', 'entity_id'],
    column_order: ['entity_id', 'donor_id']
  })
};

fetch('https://api.gratona.com/v1/admin/sponsorships/restore', 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/sponsorships/restore",
  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([
    'donor_entity_ids' => [
        4812,
        4813
    ],
    'next_action_date' => '2026-08-01',
    'force_restore' => true,
    'preview_token' => 'eyJpdiI6Ik...',
    'program_id' => 17,
    'selection_mode' => 'selected_rows',
    'filter' => 'true',
    'query' => 'Taylor',
    'status' => 'current',
    'filterGroups' => [
        [
                
        ]
    ],
    'savedFilterId' => 42,
    'fields' => [
        'donor_id',
        'entity_id'
    ],
    'column_order' => [
        'entity_id',
        'donor_id'
    ]
  ]),
  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/sponsorships/restore"

	payload := strings.NewReader("{\n  \"donor_entity_ids\": [\n    4812,\n    4813\n  ],\n  \"next_action_date\": \"2026-08-01\",\n  \"force_restore\": true,\n  \"preview_token\": \"eyJpdiI6Ik...\",\n  \"program_id\": 17,\n  \"selection_mode\": \"selected_rows\",\n  \"filter\": \"true\",\n  \"query\": \"Taylor\",\n  \"status\": \"current\",\n  \"filterGroups\": [\n    {}\n  ],\n  \"savedFilterId\": 42,\n  \"fields\": [\n    \"donor_id\",\n    \"entity_id\"\n  ],\n  \"column_order\": [\n    \"entity_id\",\n    \"donor_id\"\n  ]\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.gratona.com/v1/admin/sponsorships/restore")
  .header("X-HYS-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"donor_entity_ids\": [\n    4812,\n    4813\n  ],\n  \"next_action_date\": \"2026-08-01\",\n  \"force_restore\": true,\n  \"preview_token\": \"eyJpdiI6Ik...\",\n  \"program_id\": 17,\n  \"selection_mode\": \"selected_rows\",\n  \"filter\": \"true\",\n  \"query\": \"Taylor\",\n  \"status\": \"current\",\n  \"filterGroups\": [\n    {}\n  ],\n  \"savedFilterId\": 42,\n  \"fields\": [\n    \"donor_id\",\n    \"entity_id\"\n  ],\n  \"column_order\": [\n    \"entity_id\",\n    \"donor_id\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/admin/sponsorships/restore")

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  \"donor_entity_ids\": [\n    4812,\n    4813\n  ],\n  \"next_action_date\": \"2026-08-01\",\n  \"force_restore\": true,\n  \"preview_token\": \"eyJpdiI6Ik...\",\n  \"program_id\": 17,\n  \"selection_mode\": \"selected_rows\",\n  \"filter\": \"true\",\n  \"query\": \"Taylor\",\n  \"status\": \"current\",\n  \"filterGroups\": [\n    {}\n  ],\n  \"savedFilterId\": 42,\n  \"fields\": [\n    \"donor_id\",\n    \"entity_id\"\n  ],\n  \"column_order\": [\n    \"entity_id\",\n    \"donor_id\"\n  ]\n}"

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

{
  "message": "Sponsorships Successfully Restored.",
  "restored_count": 2,
  "skipped_count": 1,
  "skipped_ids": [
    4814
  ],
  "skipped": [
    {
      "donor_entity_id": 4814,
      "reason": "donor_inactive"
    }
  ]
}

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

{
  "message": "Something went wrong. Please try again.",
  "status": "error",
  "error": "invalid_request",
  "code": "DONOR_NOT_FOUND"
}

{
  "message": "No archived sponsorships could be restored.",
  "skipped_count": 2,
  "skipped_ids": [
    4812,
    4813
  ],
  "skipped": [
    {
      "donor_entity_id": 4812,
      "reason": "not_archived_or_not_owned"
    }
  ]
}

{
  "message": "One or more recipients are already fully sponsored.",
  "error_code": "RECIPIENT_FULLY_SPONSORED",
  "conflicts": [
    {}
  ]
}

{
  "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

Restore selected archived sponsorships

Authorizations

Body

Response