## Update a household

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

Update an existing household with new data

### Path Parameters

- `id: string`

### Body Parameters

- `external_id: optional string`

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

- `notes: optional string`

  Notes about the household

- `primary_relationship_owner_id: optional string`

  User ID of the primary relationship owner

### Returns

- `Household object { id, created_at, primary_relationship_owner_id, 5 more }`

  - `id: string`

    Unique identifier with household_ prefix

  - `created_at: string`

    Timestamp when the household was created

  - `primary_relationship_owner_id: string`

    User ID of the primary relationship owner

  - `updated_at: string`

    Timestamp when the household was last updated

  - `external_id: optional string`

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

  - `name: optional string`

    Display name for the household

  - `notes: optional string`

    Notes about the household

  - `primary_individuals: optional array of Individual`

    Primary client profiles for this household (at most 2)

    - `id: string`

      Unique identifier with client_profile_ prefix

    - `created_at: string`

      Timestamp when the individual was created

    - `first_name: string`

      First name of the individual

    - `household_id: string`

      Household ID this individual belongs to

    - `is_beneficiary: boolean`

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

    - `is_deceased: boolean`

      Whether this client profile is deceased

    - `is_grantor: boolean`

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

    - `is_primary: boolean`

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

    - `is_trustee: boolean`

      Whether this client profile should be an eligible trustee for entities

    - `last_name: string`

      Last name of the individual

    - `updated_at: string`

      Timestamp when the individual was last updated

    - `address_line1: optional string`

      Street address line 1 (from address edge)

    - `address_line2: optional string`

      Street address line 2 (from address edge)

    - `city: optional string`

      City (from address edge)

    - `country: optional string`

      Country (from address edge)

    - `date_of_birth: optional string`

      Date of birth (encrypted field)

    - `date_of_death: optional string`

      Date of death if applicable (encrypted field)

    - `deleted_at: optional string`

      Timestamp when the individual was soft deleted

    - `email: optional string`

      Email address

    - `middle_name: optional string`

      Middle name of the individual

    - `notes: optional string`

      Notes about the client profile

    - `postal_code: optional string`

      ZIP or postal code (from address edge)

    - `state: optional string`

      State or province (from address edge)

    - `suffix: optional string`

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

### Example

```http
curl https://$WITHLUMINARY_SUBDOMAIN.withluminary.com/api/public/v1/households/$ID \
    -X PUT \
    -H 'Content-Type: application/json' \
    -d '{
          "external_id": "crm-household-12345",
          "primary_relationship_owner_id": "user_01ARZ3NDEKTSV4RRFFQ69G5FAV"
        }'
```

#### 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."
    }
  ]
}
```