PATCH
Update my current home

Overview

Applies a partial update to the caller’s current_homes document. Every field in the request body is optional; only the supplied fields are written. The Mongoose pre-save hook recomputes rentMonthlyMinor whenever rent changes, so weekly→monthly normalisation stays accurate for the matching engine. Photos are managed through the dedicated /me/photos* endpoints, not this one. The description field can be updated here (subject to the 50..150-char rule) once onboarding step 3 has been submitted. PATCH does not trigger a tenancy re-review automatically. The plan calls for a re-review when material fields (address / postcode / property type) change; that wiring lands with the Phase 6 admin queue.

Authentication

Bearer <accessToken> required. Scope: user.

Path parameters

None.

Query parameters

None.

Request body

Every field is optional. Send only what you want to change.

Example payload

Response — 200 OK

Returns the updated Home object.

Error responses

Example error — 400

Side effects

  • $sets the supplied fields on the caller’s current_homes document.
  • The pre-save hook recomputes rentMonthlyMinor if rent is in the patch.
  • updatedAt is bumped to now.
  • The matching engine will pick up the new values on its next match.recompute job (currently a stub; Phase 3 implements the worker).

See also

curl