Skip to main content
DELETE
Delete an empty 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
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

Delete an empty household completed.

success
boolean

Operation completed.

Example:

true

message
string

Confirmation.

Example:

"Household deleted successfully"