Preview relationship changes affecting stewardship plans
Requires the relationship-groups feature and donors_manage. Command and operation must match. Returns affected scopes, collisions and repairs plus a five-minute impact_version; this preview does not perform the proposed mutation. Requires stewardship_major_donor_plans_v1. Relationship-group subjects also require stewardship_relationship_groups_v1. Subject access respects the viewer’s donor visibility. Requires permission: donors_view; plus one of donors_manage.
curl --request POST \
--url https://api.gratona.com/v1/admin/fundraising/stewardship-plans/lifecycle-impact \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"command": "relationship_group_create_or_update",
"operation": "create",
"relationship_group_id": 1,
"payload": {
"core_subject_type": "donor",
"core_subject_id": 42,
"assigned_fundraiser_user_id": 42,
"links": [
{
"donor_id": 42,
"role": "designated_contact",
"collapse_in_portfolio": true
}
]
}
}
'import requests
url = "https://api.gratona.com/v1/admin/fundraising/stewardship-plans/lifecycle-impact"
payload = {
"command": "relationship_group_create_or_update",
"operation": "create",
"relationship_group_id": 1,
"payload": {
"core_subject_type": "donor",
"core_subject_id": 42,
"assigned_fundraiser_user_id": 42,
"links": [
{
"donor_id": 42,
"role": "designated_contact",
"collapse_in_portfolio": True
}
]
}
}
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({
command: 'relationship_group_create_or_update',
operation: 'create',
relationship_group_id: 1,
payload: {
core_subject_type: 'donor',
core_subject_id: 42,
assigned_fundraiser_user_id: 42,
links: [{donor_id: 42, role: 'designated_contact', collapse_in_portfolio: true}]
}
})
};
fetch('https://api.gratona.com/v1/admin/fundraising/stewardship-plans/lifecycle-impact', 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/stewardship-plans/lifecycle-impact",
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([
'command' => 'relationship_group_create_or_update',
'operation' => 'create',
'relationship_group_id' => 1,
'payload' => [
'core_subject_type' => 'donor',
'core_subject_id' => 42,
'assigned_fundraiser_user_id' => 42,
'links' => [
[
'donor_id' => 42,
'role' => 'designated_contact',
'collapse_in_portfolio' => true
]
]
]
]),
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/stewardship-plans/lifecycle-impact"
payload := strings.NewReader("{\n \"command\": \"relationship_group_create_or_update\",\n \"operation\": \"create\",\n \"relationship_group_id\": 1,\n \"payload\": {\n \"core_subject_type\": \"donor\",\n \"core_subject_id\": 42,\n \"assigned_fundraiser_user_id\": 42,\n \"links\": [\n {\n \"donor_id\": 42,\n \"role\": \"designated_contact\",\n \"collapse_in_portfolio\": true\n }\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/fundraising/stewardship-plans/lifecycle-impact")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"command\": \"relationship_group_create_or_update\",\n \"operation\": \"create\",\n \"relationship_group_id\": 1,\n \"payload\": {\n \"core_subject_type\": \"donor\",\n \"core_subject_id\": 42,\n \"assigned_fundraiser_user_id\": 42,\n \"links\": [\n {\n \"donor_id\": 42,\n \"role\": \"designated_contact\",\n \"collapse_in_portfolio\": true\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/fundraising/stewardship-plans/lifecycle-impact")
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 \"command\": \"relationship_group_create_or_update\",\n \"operation\": \"create\",\n \"relationship_group_id\": 1,\n \"payload\": {\n \"core_subject_type\": \"donor\",\n \"core_subject_id\": 42,\n \"assigned_fundraiser_user_id\": 42,\n \"links\": [\n {\n \"donor_id\": 42,\n \"role\": \"designated_contact\",\n \"collapse_in_portfolio\": true\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"material_impact": true,
"affected_plans": [
{
"id": 42,
"subject": {
"type": "donor",
"id": 42
},
"stage": "qualifying",
"status": "draft",
"period": {
"start": "2026-10-20",
"end": "2026-10-20"
},
"version": 2,
"action_donor_id": 42,
"scope_version": 2
}
],
"group_plans": [
{
"id": 42,
"subject": {
"type": "donor",
"id": 42
},
"stage": "qualifying",
"status": "draft",
"period": {
"start": "2026-10-20",
"end": "2026-10-20"
},
"version": 2,
"action_donor_id": 42,
"scope_version": 2
}
],
"transfer_candidates": [
{
"id": 42,
"subject": {
"type": "donor",
"id": 42
},
"stage": "qualifying",
"status": "draft",
"period": {
"start": "2026-10-20",
"end": "2026-10-20"
},
"version": 2,
"action_donor_id": 42,
"scope_version": 2
}
],
"scope_changes": [
{
"plan_id": 42,
"added": [
{
"member_type": "donor",
"member_id": 42,
"scope_role": "Example"
}
],
"removed": [
{
"member_type": "donor",
"member_id": 42,
"scope_role": "Example"
}
],
"invalid_open_move_ids": [
42
]
}
],
"eligible_action_donor_ids": [
42
],
"collisions": [
{
"id": 42,
"subject": {
"type": "donor",
"id": 42
},
"stage": "qualifying",
"status": "draft",
"period": {
"start": "2026-10-20",
"end": "2026-10-20"
},
"version": 2,
"action_donor_id": 42,
"scope_version": 2
}
],
"authority_changes": [
{
"relationship_group_id": 42,
"previous_manager_user_id": 42,
"next_manager_user_id": 42,
"owner_review_required": true
}
],
"required_repairs": [
{
"plan_id": 42,
"choices": [
"replace_action_donor"
],
"eligible_action_donor_ids": [
42
],
"recommended_action_donor_id": 42
}
],
"command": "relationship_group_assignment",
"expires_at": "2026-10-20T12:00:00Z",
"impact_version": "Example",
"_planning_enabled": true,
"feature_enabled": true,
"plan_repairs": [
{}
],
"archived_donor_ids": [
42
]
}
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "Not Found",
"status": "error"
}{
"status": "error",
"code": "PLAN_VERSION_CONFLICT",
"message": "Example",
"data": {
"latest": {
"id": 42,
"version": 2,
"subject": {
"type": "donor",
"id": 42
},
"stage": "qualifying",
"status": "draft",
"tier": "A",
"stage_entered_at": "2026-10-20T12:00:00Z",
"action_donor_id": 42,
"period": {
"start": "2026-10-20",
"end": "2026-10-20"
},
"currency": "USD",
"goal_amount": 1000,
"attributed_actual": 1000,
"direct_actual": 1000,
"soft_credit_actual": 1000,
"variance_amount": 1000,
"gift_count": 2,
"giving_status": "pending",
"giving_last_successful_at": "2026-10-20T12:00:00Z",
"currency_breakdown": [
{
"currency": "Example",
"attributed_actual": 1000,
"direct_actual": 1000,
"soft_credit_actual": 1000,
"gift_count": 2
}
],
"next_move": {
"id": 42,
"title": "Example",
"planned_at": "2026-10-20T12:00:00Z"
},
"open_move_count": 2,
"overdue_move_count": 2,
"health": {
"status": "Example",
"reasons": [
"overdue_move"
]
},
"metric_basis": "relationship_attribution"
},
"conflicting_plan": {}
}
}{
"errors": {},
"status": "error",
"message": "The given data was invalid."
}Authorizations
Passport bearer token authentication for legacy admin sessions.
Body
Validated request fields for this operation.
Command. Validation: required; allowed values: relationship_group_create_or_update, relationship_group_assignment, relationship_group_deactivate.
relationship_group_create_or_update, relationship_group_assignment, relationship_group_deactivate "relationship_group_create_or_update"
Operation. Validation: required; allowed values: create, update, assignment, deactivate.
create, update, assignment, deactivate "create"
Relationship group id. Validation: nullable, integer, min:1.
x >= 11
Proposed relationship payload. Core, links and assignment fields are interpreted for the selected operation; separate relationship mutation validation still applies.
Show child attributes
Show child attributes
curl --request POST \
--url https://api.gratona.com/v1/admin/fundraising/stewardship-plans/lifecycle-impact \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"command": "relationship_group_create_or_update",
"operation": "create",
"relationship_group_id": 1,
"payload": {
"core_subject_type": "donor",
"core_subject_id": 42,
"assigned_fundraiser_user_id": 42,
"links": [
{
"donor_id": 42,
"role": "designated_contact",
"collapse_in_portfolio": true
}
]
}
}
'import requests
url = "https://api.gratona.com/v1/admin/fundraising/stewardship-plans/lifecycle-impact"
payload = {
"command": "relationship_group_create_or_update",
"operation": "create",
"relationship_group_id": 1,
"payload": {
"core_subject_type": "donor",
"core_subject_id": 42,
"assigned_fundraiser_user_id": 42,
"links": [
{
"donor_id": 42,
"role": "designated_contact",
"collapse_in_portfolio": True
}
]
}
}
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({
command: 'relationship_group_create_or_update',
operation: 'create',
relationship_group_id: 1,
payload: {
core_subject_type: 'donor',
core_subject_id: 42,
assigned_fundraiser_user_id: 42,
links: [{donor_id: 42, role: 'designated_contact', collapse_in_portfolio: true}]
}
})
};
fetch('https://api.gratona.com/v1/admin/fundraising/stewardship-plans/lifecycle-impact', 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/stewardship-plans/lifecycle-impact",
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([
'command' => 'relationship_group_create_or_update',
'operation' => 'create',
'relationship_group_id' => 1,
'payload' => [
'core_subject_type' => 'donor',
'core_subject_id' => 42,
'assigned_fundraiser_user_id' => 42,
'links' => [
[
'donor_id' => 42,
'role' => 'designated_contact',
'collapse_in_portfolio' => true
]
]
]
]),
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/stewardship-plans/lifecycle-impact"
payload := strings.NewReader("{\n \"command\": \"relationship_group_create_or_update\",\n \"operation\": \"create\",\n \"relationship_group_id\": 1,\n \"payload\": {\n \"core_subject_type\": \"donor\",\n \"core_subject_id\": 42,\n \"assigned_fundraiser_user_id\": 42,\n \"links\": [\n {\n \"donor_id\": 42,\n \"role\": \"designated_contact\",\n \"collapse_in_portfolio\": true\n }\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/fundraising/stewardship-plans/lifecycle-impact")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"command\": \"relationship_group_create_or_update\",\n \"operation\": \"create\",\n \"relationship_group_id\": 1,\n \"payload\": {\n \"core_subject_type\": \"donor\",\n \"core_subject_id\": 42,\n \"assigned_fundraiser_user_id\": 42,\n \"links\": [\n {\n \"donor_id\": 42,\n \"role\": \"designated_contact\",\n \"collapse_in_portfolio\": true\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/fundraising/stewardship-plans/lifecycle-impact")
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 \"command\": \"relationship_group_create_or_update\",\n \"operation\": \"create\",\n \"relationship_group_id\": 1,\n \"payload\": {\n \"core_subject_type\": \"donor\",\n \"core_subject_id\": 42,\n \"assigned_fundraiser_user_id\": 42,\n \"links\": [\n {\n \"donor_id\": 42,\n \"role\": \"designated_contact\",\n \"collapse_in_portfolio\": true\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"material_impact": true,
"affected_plans": [
{
"id": 42,
"subject": {
"type": "donor",
"id": 42
},
"stage": "qualifying",
"status": "draft",
"period": {
"start": "2026-10-20",
"end": "2026-10-20"
},
"version": 2,
"action_donor_id": 42,
"scope_version": 2
}
],
"group_plans": [
{
"id": 42,
"subject": {
"type": "donor",
"id": 42
},
"stage": "qualifying",
"status": "draft",
"period": {
"start": "2026-10-20",
"end": "2026-10-20"
},
"version": 2,
"action_donor_id": 42,
"scope_version": 2
}
],
"transfer_candidates": [
{
"id": 42,
"subject": {
"type": "donor",
"id": 42
},
"stage": "qualifying",
"status": "draft",
"period": {
"start": "2026-10-20",
"end": "2026-10-20"
},
"version": 2,
"action_donor_id": 42,
"scope_version": 2
}
],
"scope_changes": [
{
"plan_id": 42,
"added": [
{
"member_type": "donor",
"member_id": 42,
"scope_role": "Example"
}
],
"removed": [
{
"member_type": "donor",
"member_id": 42,
"scope_role": "Example"
}
],
"invalid_open_move_ids": [
42
]
}
],
"eligible_action_donor_ids": [
42
],
"collisions": [
{
"id": 42,
"subject": {
"type": "donor",
"id": 42
},
"stage": "qualifying",
"status": "draft",
"period": {
"start": "2026-10-20",
"end": "2026-10-20"
},
"version": 2,
"action_donor_id": 42,
"scope_version": 2
}
],
"authority_changes": [
{
"relationship_group_id": 42,
"previous_manager_user_id": 42,
"next_manager_user_id": 42,
"owner_review_required": true
}
],
"required_repairs": [
{
"plan_id": 42,
"choices": [
"replace_action_donor"
],
"eligible_action_donor_ids": [
42
],
"recommended_action_donor_id": 42
}
],
"command": "relationship_group_assignment",
"expires_at": "2026-10-20T12:00:00Z",
"impact_version": "Example",
"_planning_enabled": true,
"feature_enabled": true,
"plan_repairs": [
{}
],
"archived_donor_ids": [
42
]
}
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "Not Found",
"status": "error"
}{
"status": "error",
"code": "PLAN_VERSION_CONFLICT",
"message": "Example",
"data": {
"latest": {
"id": 42,
"version": 2,
"subject": {
"type": "donor",
"id": 42
},
"stage": "qualifying",
"status": "draft",
"tier": "A",
"stage_entered_at": "2026-10-20T12:00:00Z",
"action_donor_id": 42,
"period": {
"start": "2026-10-20",
"end": "2026-10-20"
},
"currency": "USD",
"goal_amount": 1000,
"attributed_actual": 1000,
"direct_actual": 1000,
"soft_credit_actual": 1000,
"variance_amount": 1000,
"gift_count": 2,
"giving_status": "pending",
"giving_last_successful_at": "2026-10-20T12:00:00Z",
"currency_breakdown": [
{
"currency": "Example",
"attributed_actual": 1000,
"direct_actual": 1000,
"soft_credit_actual": 1000,
"gift_count": 2
}
],
"next_move": {
"id": 42,
"title": "Example",
"planned_at": "2026-10-20T12:00:00Z"
},
"open_move_count": 2,
"overdue_move_count": 2,
"health": {
"status": "Example",
"reasons": [
"overdue_move"
]
},
"metric_basis": "relationship_attribution"
},
"conflicting_plan": {}
}
}{
"errors": {},
"status": "error",
"message": "The given data was invalid."
}