# Update household

**PUT /api/v2/household/{HouseholdGUID}**

This endpoint allows users to update a household.


## Servers
- https://api.fincalc.co.uk: https://api.fincalc.co.uk ()


## Authentication methods
- Bearer auth


## Parameters

### Path parameters
- **HouseholdGUID** (string(uuid))
  The HouseholdGUID of the client.


### Body: application/json (object)

- **ClientGUID** (string(uuid))

- **RelatedClientGUID** (string(uuid) | null)
  RelatedClientGUID must be different from ClientGUID
- **HouseholdLabel** (string | null)

- **BaselineAssumptionSetGUID** (string(uuid) | null)
  To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/options
- **ExcludeFormattedValues** (string | null)
  If set to any value, formatted values will be excluded from the response.


## Responses
### 200
Success

#### Body: application/json (object)
- **success** (boolean)

- **data** (object)

- **message** (string)


### 403
Permission error.

#### Body: application/json (object)
- **success** (boolean)

- **message** (string)


### 404
Client not found.

#### Body: application/json (object)
- **success** (boolean)

- **message** (string)


### 409
Unable to edit client due to status of clients.

#### Body: application/json (object)
- **success** (boolean)

- **message** (string)


### 422
Validation error.

#### Body: application/json (object)
- **success** (boolean)

- **message** (string)

- **data** (object)
  Example validation error message.


[Powered by Bump.sh](https://bump.sh)