Skip to main content
PATCH
Update household and membership

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
name
string

Supplied name must be nonblank; omitted name is preserved.

Maximum string length: 255
Example:

"Doe household"

primary_contact_id
integer

Active organization donor, automatically included in membership.

Example:

42

address
object | null

Partial address; omitted and null components preserve the existing value.

json_fields

Household custom values; request accepts a JSON object or list.

donor_ids
integer[] | null

When supplied, replaces membership after adding the effective primary donor; omission preserves current membership.

Active member donor; primary is included automatically.

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
is_active
boolean

Optional stored active flag accepted by the controller.

Example:

false

Response

Update household and membership completed.

success
boolean

Operation completed.

Example:

true

message
string

Confirmation.

Example:

"Household updated successfully"

household
object