Skip to main content
POST
Add one donor to a household

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

household_id
integer
required

Record ID in the authenticated organization.

Example:

42

donor_id
integer
required

Record ID in the authenticated organization.

Example:

42

Body

application/json
relationship
enum<string>
required

Household relationship label.

Available options:
Church,
Employer,
Employee,
Friend,
Director,
Associate,
Child,
Parent,
Grandparent,
Grandchild,
Relative,
Spouse,
Sibling,
Designated Registrant,
Registrant,
Church Member,
Partner,
Organization,
Member,
Beneficiary,
Sponsor
Example:

"Church"

primary_relationship
enum<string> | null

Household relationship label.

Available options:
Church,
Employer,
Employee,
Friend,
Director,
Associate,
Child,
Parent,
Grandparent,
Grandchild,
Relative,
Spouse,
Sibling,
Designated Registrant,
Registrant,
Church Member,
Partner,
Organization,
Member,
Beneficiary,
Sponsor,
null
Example:

"Church"

primary
integer | null

Fallback donor for primary_relationship when household has no primary.

Example:

42

make_primary
boolean

Make the new donor primary; send JSON true to activate.

Example:

false

plan_impact_version
string | null

Token from a 409 stewardship impact response; required when open plan impact is material.

Maximum string length: 4096
Example:

"issued-household-impact-version"

plan_repairs
object[] | null

Response

Add one donor to a household completed.

success
boolean

Operation completed.

Example:

true

message
string

Confirmation.

Example:

"Donor successfully added to household"

is_primary
boolean

This request made the member primary.

Example:

false

donor
object
household
object