households

Apply a collection-level delta

{ set, upsert, remove } against the stored document; the merged result is validated. expectedVersion is required. Emits household.updated with changed.

patch/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

Request body

expectedVersioninteger required

REQUIRED for PATCH — a delta is only meaningful against a version you have read.

labelstring nullable
advisorRefstring nullable

Response

Patched; the new document is returned.

okunknown required
changedstring[] required

Paths touched, e.g. "set.state", "upsert.accounts[brokerage]", "remove.liabilities[auto]".

Changes

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