households

Archive a household

Rows are never destroyed: an archived household stays readable, leaves the meter, and refuses further writes and runs. Emits household.archived.

delete/api/v1/households/{id}

Request

  • Base URL: https://worthune.com
  • URL: https://worthune.com/api/v1/households/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Response

Archived — or already archived (alreadyArchived: true; nothing changed, no second household.archived event). Archiving bumps the version.

okunknown required
archivedunknown required
alreadyArchivedboolean required
versioninteger required

Changes

No recorded changes to this operation across all 1 revision of this API.