households

Create a household

Validates the document (reject, never clamp) and stores it. With importKey, the create is idempotent: a retry that matches an existing row answers 200 with action: "already-created".

post/api/v1/households

Request

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

Request body

labelstring nullable

Truncated to 128 chars.

advisorRefstring nullable

"" is treated as absent. Truncated to 128 chars.

importKeystring nullable

Your own stable id; makes the create idempotent (a retry that matches answers 200 with the existing row).

Response

The importKey matched a row this org already created; that row is returned untouched.

okunknown required
action'already-created' required

Changes

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