Skip to main content
POST
Add multiple donors 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

Body

application/json
donors
object[]
required
Minimum array length: 1
primary_contact_id
integer

Current/new member to select as primary.

Example:

42

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 multiple donors to a household completed.

success
boolean

Operation completed.

Example:

true

message
string

Confirmation.

Example:

"Donors added to household successfully"

added_donors
object[]
errors
string[]

Rejected row explanation.

household
object