## Update a household

`client.Households.Update(ctx, id, body) (*Household, error)`

**put** `/households/{id}`

Update an existing household with new data

### Parameters

- `id string`

- `body HouseholdUpdateParams`

  - `ExternalID param.Field[string]`

    Customer-supplied identifier from an external system. Unique within the caller's tenant when set. Send null to clear.

  - `Notes param.Field[string]`

    Notes about the household

  - `PrimaryRelationshipOwnerID param.Field[string]`

    User ID of the primary relationship owner

### Returns

- `type Household struct{…}`

  - `ID string`

    Unique identifier with household_ prefix

  - `CreatedAt Time`

    Timestamp when the household was created

  - `PrimaryRelationshipOwnerID string`

    User ID of the primary relationship owner

  - `UpdatedAt Time`

    Timestamp when the household was last updated

  - `ExternalID string`

    Customer-supplied identifier from an external system. Unique within the caller's tenant when set.

  - `Name string`

    Display name for the household

  - `Notes string`

    Notes about the household

  - `PrimaryIndividuals []Individual`

    Primary client profiles for this household (at most 2)

    - `ID string`

      Unique identifier with client_profile_ prefix

    - `CreatedAt Time`

      Timestamp when the individual was created

    - `FirstName string`

      First name of the individual

    - `HouseholdID string`

      Household ID this individual belongs to

    - `IsBeneficiary bool`

      Whether this client profile should be an eligible beneficiary for entities and gifts

    - `IsDeceased bool`

      Whether this client profile is deceased

    - `IsGrantor bool`

      Whether this client profile should be an eligible grantor/owner/other principal for entities

    - `IsPrimary bool`

      Whether this is one of the (at most) two primary clients on this household

    - `IsTrustee bool`

      Whether this client profile should be an eligible trustee for entities

    - `LastName string`

      Last name of the individual

    - `UpdatedAt Time`

      Timestamp when the individual was last updated

    - `AddressLine1 string`

      Street address line 1 (from address edge)

    - `AddressLine2 string`

      Street address line 2 (from address edge)

    - `City string`

      City (from address edge)

    - `Country string`

      Country (from address edge)

    - `DateOfBirth Time`

      Date of birth (encrypted field)

    - `DateOfDeath Time`

      Date of death if applicable (encrypted field)

    - `DeletedAt Time`

      Timestamp when the individual was soft deleted

    - `Email string`

      Email address

    - `MiddleName string`

      Middle name of the individual

    - `Notes string`

      Notes about the client profile

    - `PostalCode string`

      ZIP or postal code (from address edge)

    - `State string`

      State or province (from address edge)

    - `Suffix string`

      Name suffix (Jr., Sr., III, etc.)

### Example

```go
package main

import (
  "context"
  "fmt"

  "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"),
  )
  household, err := client.Households.Update(
    context.TODO(),
    "id",
    withluminary.HouseholdUpdateParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", household.ID)
}
```

#### Response

```json
{
  "id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "created_at": "2024-01-15T09:30:00Z",
  "primary_relationship_owner_id": "user_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "updated_at": "2024-01-20T14:45:00Z",
  "external_id": "crm-household-12345",
  "name": "Smith Family",
  "notes": "notes",
  "primary_individuals": [
    {
      "id": "client_profile_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "created_at": "2024-01-15T09:30:00Z",
      "first_name": "John",
      "household_id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "is_beneficiary": true,
      "is_deceased": true,
      "is_grantor": true,
      "is_primary": true,
      "is_trustee": true,
      "last_name": "Smith",
      "updated_at": "2024-01-20T14:45:00Z",
      "address_line1": "123 Main St",
      "address_line2": "Apt 4B",
      "city": "San Francisco",
      "country": "USA",
      "date_of_birth": "1980-05-15",
      "date_of_death": "2019-12-27",
      "deleted_at": "2019-12-27T18:11:19.117Z",
      "email": "john.smith@example.com",
      "middle_name": "Michael",
      "notes": "notes",
      "postal_code": "94102",
      "state": "CA",
      "suffix": "Jr."
    }
  ]
}
```