---
title: "UpdateProperty"
url: "https://developer.pexa.co.uk/apis/instruction-v1-v1/versions/861f183b-600d-4bbf-9762-abebcbf9b5ac/schemas/UpdateProperty"
---

> Full API specification: https://developer.pexa.co.uk/apis/instruction-v1-v1/versions/861f183b-600d-4bbf-9762-abebcbf9b5ac.md

# UpdateProperty

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Lender Instruction
  version: v1
servers:
  - url: https://api.pexa.co.uk
    description: API Gateway URL
components:
  schemas:
    UpdateProperty:
      type: object
      properties:
        unencumbered:
          type: boolean
          description: Indicates if the property is unencumbered
        newBuild:
          type: boolean
          description: Indicates if the property is a new build
        address:
          description: Property address. Partial address updates are discouraged. Any
            update will fully overwrite the existing address, so you should
            provide the complete address payload with every address update.
          type: object
          required:
            - postcode
          properties:
            flat:
              type: string
              description: Flat/apartment number
            name:
              type: string
              description: Building name
            number:
              type: string
              description: House/building number
            street:
              type: string
              description: Street name
            town:
              type: string
              description: Town/city
            postcode:
              maxLength: 8
              minLength: 6
              type: string
              example: M16 0RA
              pattern: ^(([Gg][Ii][Rr]
                0[Aa]{2})|((([A-Za-z][0-9]{1,2})|(([A-Za-z][A-Ha-hJ-Yj-y][0-9]{1,2})|(([A-Za-z][0-9][A-Za-z])|([A-Za-z][A-Ha-hJ-Yj-y][0-9][A-Za-z]?))))\s[0-9][A-Za-z]{2}))$
            locality:
              type: string
              description: Locality
            county:
              type: string
              description: County name
```