Skip to main content
POST
Create a stewardship relationship

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Body

application/json

Validated request fields for this operation.

kind
enum<string>
required

Kind. Validation: required; allowed values: family_fund, business_family, organization.

Available options:
family_fund,
business_family,
organization
Example:

"family_fund"

display_name
string
required

Display name. Validation: required, string, max:255.

Maximum string length: 255
Example:

"Display Name"

core_subject_type
enum<string>
required

Core subject type. Validation: required; allowed values: donor, household.

Available options:
donor,
household
Example:

"donor"

core_subject_id
integer
required

Core subject id. Validation: required, integer, min:1.

Required range: x >= 1
Example:

1

assigned_fundraiser_user_id
integer | null

Assigned fundraiser user id. Validation: nullable, integer.

Example:

1

Links. Validation: nullable, array, max:100.

Maximum array length: 100
plan_impact_version
string | null

Current signed impact_version from stewardship-plans/lifecycle-impact, required when the mutation materially affects open plans.

Maximum string length: 4096
Example:

"Plan Impact Version"

plan_repairs
object[] | null

Plan repairs. Validation: nullable, array, max:25.

Maximum array length: 25

Response

Operation result.

status
string
Example:

"success"

data
object

Active relationship group. Detailed reads add missing expected attribution; detail giving-vehicle links add legal giving totals; mutations may include committed projection/owner warnings.