Fundraising
Deactivate a stewardship relationship
Requires stewardship_relationship_groups_v1. Deactivates while retaining historical links, removes live portfolio projection and reconciles affected plans/owners. Plan repairs/confirmation are required when material impact exists. Requires permission: donors_view; plus one of donors_manage.
DELETE
/
admin
/
fundraising
/
relationship-groups
/
{relationship_group_id}
Deactivate a stewardship relationship
curl --request DELETE \
--url https://api.gratona.com/v1/admin/fundraising/relationship-groups/{relationship_group_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"plan_impact_version": "Plan Impact Version",
"plan_repairs": [
{
"plan_id": 1,
"action": "keep_original_subject",
"action_donor_id": 1,
"reason": "Plan Repairs.*.Reason"
}
]
}
'import requests
url = "https://api.gratona.com/v1/admin/fundraising/relationship-groups/{relationship_group_id}"
payload = {
"plan_impact_version": "Plan Impact Version",
"plan_repairs": [
{
"plan_id": 1,
"action": "keep_original_subject",
"action_donor_id": 1,
"reason": "Plan Repairs.*.Reason"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
plan_impact_version: 'Plan Impact Version',
plan_repairs: [
{
plan_id: 1,
action: 'keep_original_subject',
action_donor_id: 1,
reason: 'Plan Repairs.*.Reason'
}
]
})
};
fetch('https://api.gratona.com/v1/admin/fundraising/relationship-groups/{relationship_group_id}', 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/fundraising/relationship-groups/{relationship_group_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'plan_impact_version' => 'Plan Impact Version',
'plan_repairs' => [
[
'plan_id' => 1,
'action' => 'keep_original_subject',
'action_donor_id' => 1,
'reason' => 'Plan Repairs.*.Reason'
]
]
]),
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/fundraising/relationship-groups/{relationship_group_id}"
payload := strings.NewReader("{\n \"plan_impact_version\": \"Plan Impact Version\",\n \"plan_repairs\": [\n {\n \"plan_id\": 1,\n \"action\": \"keep_original_subject\",\n \"action_donor_id\": 1,\n \"reason\": \"Plan Repairs.*.Reason\"\n }\n ]\n}")
req, _ := http.NewRequest("DELETE", 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.delete("https://api.gratona.com/v1/admin/fundraising/relationship-groups/{relationship_group_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"plan_impact_version\": \"Plan Impact Version\",\n \"plan_repairs\": [\n {\n \"plan_id\": 1,\n \"action\": \"keep_original_subject\",\n \"action_donor_id\": 1,\n \"reason\": \"Plan Repairs.*.Reason\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/fundraising/relationship-groups/{relationship_group_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"plan_impact_version\": \"Plan Impact Version\",\n \"plan_repairs\": [\n {\n \"plan_id\": 1,\n \"action\": \"keep_original_subject\",\n \"action_donor_id\": 1,\n \"reason\": \"Plan Repairs.*.Reason\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"deactivated": true,
"id": 42,
"warnings": [
{
"code": "Example",
"message": "Example"
}
]
}
}{
"message": "Unauthorized",
"status": "error"
}{
"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
Relationship group id in the current organization.
Body
application/json
Validated request fields for this operation.
Current signed impact_version from stewardship-plans/lifecycle-impact, required when the mutation materially affects open plans.
Maximum string length:
4096Example:
"Plan Impact Version"
Plan repairs. Validation: nullable, array, max:25.
Maximum array length:
25Show child attributes
Show child attributes
⌘I
Deactivate a stewardship relationship
curl --request DELETE \
--url https://api.gratona.com/v1/admin/fundraising/relationship-groups/{relationship_group_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"plan_impact_version": "Plan Impact Version",
"plan_repairs": [
{
"plan_id": 1,
"action": "keep_original_subject",
"action_donor_id": 1,
"reason": "Plan Repairs.*.Reason"
}
]
}
'import requests
url = "https://api.gratona.com/v1/admin/fundraising/relationship-groups/{relationship_group_id}"
payload = {
"plan_impact_version": "Plan Impact Version",
"plan_repairs": [
{
"plan_id": 1,
"action": "keep_original_subject",
"action_donor_id": 1,
"reason": "Plan Repairs.*.Reason"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
plan_impact_version: 'Plan Impact Version',
plan_repairs: [
{
plan_id: 1,
action: 'keep_original_subject',
action_donor_id: 1,
reason: 'Plan Repairs.*.Reason'
}
]
})
};
fetch('https://api.gratona.com/v1/admin/fundraising/relationship-groups/{relationship_group_id}', 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/fundraising/relationship-groups/{relationship_group_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'plan_impact_version' => 'Plan Impact Version',
'plan_repairs' => [
[
'plan_id' => 1,
'action' => 'keep_original_subject',
'action_donor_id' => 1,
'reason' => 'Plan Repairs.*.Reason'
]
]
]),
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/fundraising/relationship-groups/{relationship_group_id}"
payload := strings.NewReader("{\n \"plan_impact_version\": \"Plan Impact Version\",\n \"plan_repairs\": [\n {\n \"plan_id\": 1,\n \"action\": \"keep_original_subject\",\n \"action_donor_id\": 1,\n \"reason\": \"Plan Repairs.*.Reason\"\n }\n ]\n}")
req, _ := http.NewRequest("DELETE", 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.delete("https://api.gratona.com/v1/admin/fundraising/relationship-groups/{relationship_group_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"plan_impact_version\": \"Plan Impact Version\",\n \"plan_repairs\": [\n {\n \"plan_id\": 1,\n \"action\": \"keep_original_subject\",\n \"action_donor_id\": 1,\n \"reason\": \"Plan Repairs.*.Reason\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/fundraising/relationship-groups/{relationship_group_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"plan_impact_version\": \"Plan Impact Version\",\n \"plan_repairs\": [\n {\n \"plan_id\": 1,\n \"action\": \"keep_original_subject\",\n \"action_donor_id\": 1,\n \"reason\": \"Plan Repairs.*.Reason\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"deactivated": true,
"id": 42,
"warnings": [
{
"code": "Example",
"message": "Example"
}
]
}
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "Not Found",
"status": "error"
}{
"errors": {},
"status": "error",
"message": "The given data was invalid."
}