STstreet
Properties

Update Property Key Features

Changed on

This endpoint allows you to create or update key features for a Property record via its ID.

  • To create new features, omit the id field in each feature object
  • To update existing features, include the id field with the feature's ID
  • The endpoint will return the updated property with all its current key features
post/key-features/{property_id}

Request

Request body

Example request

{
  "data": {
    "attributes": {
      "key_features": [
        {
          "name": "Double glazing"
        }
      ]
    }
  }
}

Response

Created - Property updated successfully with new key features

Example response

{
  "data": {
    "attributes": {
      "address": {
        "single_line": "19 Lansdowne Road, Monton, Manchester",
        "anon_single_line": "Lansdowne Road, Monton, Manchester",
        "building_number": "19",
        "line_1": "19 Lansdowne Road",
        "line_2": "Monton",
        "line_3": "Manchester",
        "town": "Manchester",
        "country": "United Kingdom",
        "postcode": "M30 9PA",
        "udprn": "28327204",
        "geo": {
          "lat": 0.2365698,
          "lng": 53.023654
        }
      },
      "material_information": {
        "council_tax_band": "D"
      }
    },
    "relationships": {
      "branch": {
        "data": {
          "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
        }
      },
      "owner": {
        "data": {
          "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
        }
      },
      "media": {
        "data": [
          {
            "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
          }
        ]
      },
      "floorplans": {
        "data": [
          {
            "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
          }
        ]
      },
      "rooms": {
        "data": [
          {
            "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
          }
        ]
      },
      "epc": {
        "data": {
          "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
        }
      },
      "brochure": {
        "data": {
          "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
        }
      },
      "outsideSpaces": {
        "data": [
          {
            "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
          }
        ]
      },
      "parking": {
        "data": [
          {
            "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
          }
        ]
      },
      "viewings": {
        "data": [
          {
            "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
          }
        ]
      },
      "valuations": {
        "data": [
          {
            "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
          }
        ]
      },
      "notes": {
        "data": [
          {
            "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
          }
        ]
      },
      "negotiator": {
        "data": {
          "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
        }
      },
      "followUp": {
        "data": {
          "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
        }
      },
      "sales": {
        "data": [
          {
            "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
          }
        ]
      },
      "salesListing": {
        "data": {
          "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
        }
      },
      "lettingsListing": {
        "data": {
          "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
        }
      },
      "interestedApplicants": {
        "data": [
          {
            "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
          }
        ]
      },
      "propertyKeys": {
        "data": [
          {
            "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
          }
        ]
      }
    }
  },
  "included": [
    {
      "attributes": {
        "address": {
          "single_line": "19 Lansdowne Road, Monton, Manchester",
          "anon_single_line": "Lansdowne Road, Monton, Manchester",
          "building_number": "19",
          "line_1": "19 Lansdowne Road",
          "line_2": "Monton",
          "line_3": "Manchester",
          "town": "Manchester",
          "country": "United Kingdom",
          "postcode": "M30 9PA",
          "udprn": "28327204",
          "geo": {
            "lat": 0.2365698,
            "lng": 53.023654
          }
        }
      }
    }
  ],
  "links": {
    "self": "http://localhost:3000/users?page[number]=2&page[size]=25&page[number]=2",
    "first": "http://localhost:3000/users?page[number]=2&page[size]=25&page[number]=1",
    "next": "http://localhost:3000/users?page[number]=2&page[size]=25&page[number]=1",
    "prev": "http://localhost:3000/users?page[number]=2&page[size]=25&page[number]=3",
    "last": "http://localhost:3000/users?page[number]=2&page[size]=25&page[number]=9"
  }
}

Changes

  • b01c2825aba9Revision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

  • 6ed52b1e6e1eRevision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status