Commitments
Archive Sponsorships for Donors
POST
/
admin
/
sponsorships
/
archive
Archive Sponsorships for Donors
curl --request POST \
--url https://api.gratona.com/v1/admin/sponsorships/archive \
--header 'Content-Type: application/json' \
--header 'X-HYS-API-Key: <api-key>' \
--data '
{
"donor_entity_ids": [
1,
2,
3
],
"preview_token": "eyJpdiI6Ik...",
"reason_code": "donor_cancelled",
"notes": "<string>",
"effective_at": "2023-12-25"
}
'import requests
url = "https://api.gratona.com/v1/admin/sponsorships/archive"
payload = {
"donor_entity_ids": [1, 2, 3],
"preview_token": "eyJpdiI6Ik...",
"reason_code": "donor_cancelled",
"notes": "<string>",
"effective_at": "2023-12-25"
}
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: [1, 2, 3],
preview_token: 'eyJpdiI6Ik...',
reason_code: 'donor_cancelled',
notes: '<string>',
effective_at: '2023-12-25'
})
};
fetch('https://api.gratona.com/v1/admin/sponsorships/archive', 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/archive",
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' => [
1,
2,
3
],
'preview_token' => 'eyJpdiI6Ik...',
'reason_code' => 'donor_cancelled',
'notes' => '<string>',
'effective_at' => '2023-12-25'
]),
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/archive"
payload := strings.NewReader("{\n \"donor_entity_ids\": [\n 1,\n 2,\n 3\n ],\n \"preview_token\": \"eyJpdiI6Ik...\",\n \"reason_code\": \"donor_cancelled\",\n \"notes\": \"<string>\",\n \"effective_at\": \"2023-12-25\"\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/archive")
.header("X-HYS-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"donor_entity_ids\": [\n 1,\n 2,\n 3\n ],\n \"preview_token\": \"eyJpdiI6Ik...\",\n \"reason_code\": \"donor_cancelled\",\n \"notes\": \"<string>\",\n \"effective_at\": \"2023-12-25\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/sponsorships/archive")
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 1,\n 2,\n 3\n ],\n \"preview_token\": \"eyJpdiI6Ik...\",\n \"reason_code\": \"donor_cancelled\",\n \"notes\": \"<string>\",\n \"effective_at\": \"2023-12-25\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Sponsorships Successfully Removed."
}{
"message": "Invalid input."
}Authorizations
apiKeyAuthbearerAuth
Gratona API key sent with the compatibility header X-HYS-API-Key.
Body
application/json
Data needed to archive sponsorships for a donor
Example:
[1, 2, 3]
Short-lived token binding the mutation to the exact resolved selection and billing state. Required while sponsorship lifecycle controls are enabled.
Example:
"eyJpdiI6Ik..."
Example:
"donor_cancelled"
Maximum string length:
2000Response
Successful operation
Example:
"Sponsorships Successfully Removed."
⌘I
Archive Sponsorships for Donors
curl --request POST \
--url https://api.gratona.com/v1/admin/sponsorships/archive \
--header 'Content-Type: application/json' \
--header 'X-HYS-API-Key: <api-key>' \
--data '
{
"donor_entity_ids": [
1,
2,
3
],
"preview_token": "eyJpdiI6Ik...",
"reason_code": "donor_cancelled",
"notes": "<string>",
"effective_at": "2023-12-25"
}
'import requests
url = "https://api.gratona.com/v1/admin/sponsorships/archive"
payload = {
"donor_entity_ids": [1, 2, 3],
"preview_token": "eyJpdiI6Ik...",
"reason_code": "donor_cancelled",
"notes": "<string>",
"effective_at": "2023-12-25"
}
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: [1, 2, 3],
preview_token: 'eyJpdiI6Ik...',
reason_code: 'donor_cancelled',
notes: '<string>',
effective_at: '2023-12-25'
})
};
fetch('https://api.gratona.com/v1/admin/sponsorships/archive', 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/archive",
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' => [
1,
2,
3
],
'preview_token' => 'eyJpdiI6Ik...',
'reason_code' => 'donor_cancelled',
'notes' => '<string>',
'effective_at' => '2023-12-25'
]),
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/archive"
payload := strings.NewReader("{\n \"donor_entity_ids\": [\n 1,\n 2,\n 3\n ],\n \"preview_token\": \"eyJpdiI6Ik...\",\n \"reason_code\": \"donor_cancelled\",\n \"notes\": \"<string>\",\n \"effective_at\": \"2023-12-25\"\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/archive")
.header("X-HYS-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"donor_entity_ids\": [\n 1,\n 2,\n 3\n ],\n \"preview_token\": \"eyJpdiI6Ik...\",\n \"reason_code\": \"donor_cancelled\",\n \"notes\": \"<string>\",\n \"effective_at\": \"2023-12-25\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/sponsorships/archive")
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 1,\n 2,\n 3\n ],\n \"preview_token\": \"eyJpdiI6Ik...\",\n \"reason_code\": \"donor_cancelled\",\n \"notes\": \"<string>\",\n \"effective_at\": \"2023-12-25\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Sponsorships Successfully Removed."
}{
"message": "Invalid input."
}