Skip to main content
DELETE
Remove a donor from 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
force
boolean

Supply to acknowledge removing the primary without replacement.

Example:

false

new_primary_contact_id
integer | null

Another active member to retain 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

Remove a donor from a household completed.

success
boolean

Operation completed.

Example:

true

message
string

Confirmation.

Example:

"Donor successfully removed from household"

was_primary
boolean

Removed member was primary.

Example:

false

donor
object
household
object