API Reference

Households

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Delete a household

client.Households.Delete(ctx, id) error

delete/households/{id}

Soft delete a household (marks as deleted but preserves data)

ParametersExpand Collapse

id string

Delete a household

Go

HTTP

TypeScript

Python

Go

package main

import (
  "context"

  "github.com/withluminary/go-sdk"
  "github.com/withluminary/go-sdk/option"
)

func main() {
  client := withluminary.NewClient(
    option.WithClientID("My Client ID"),
    option.WithClientSecret("My Client Secret"),
  )
  err := client.Households.Delete(context.TODO(), "id")
  if err != nil {
    panic(err.Error())
  }
}

Returns Examples