PUT api/property/{id}/updateaddress

A command driven endpoint to Update a property address. Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The id of the property	integer	Required

Body Parameters

The address data

AddressSaveCommandDataContract

Name	Description	Type	Additional information
Latitude	The latitude value.	decimal number	None.
Longitude	The longitude value.	decimal number	None.
AddressSource	The address source value.	EnumDataContract	None.
SourceId	The unique identifier of the related source resource.	string	None.
OrganizationName	The organization name value.	string	None.
Number	The number value.	string	None.
BuildingName	The building name value.	string	None.
Street	The street value.	string	None.
Town	The town value.	string	None.
Locality	The locality value.	string	None.
County	The county value.	string	None.
Country	The country value.	string	None.
Postcode	The postcode value.	string	None.
Uprn	The uprn value.	string	None.
CreatedDate	The created date, expressed as a date and time.	date	None.
CreatedBy	The created by value.	CreatedByDataContract	None.
Id	The unique identifier of this resource.	integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "Latitude": 1.1,
  "Longitude": 2.1,
  "AddressSource": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "SourceId": "sample string 3",
  "OrganizationName": "sample string 4",
  "Number": "sample string 5",
  "BuildingName": "sample string 6",
  "Street": "sample string 7",
  "Town": "sample string 8",
  "Locality": "sample string 9",
  "County": "sample string 10",
  "Country": "sample string 11",
  "Postcode": "sample string 12",
  "Uprn": "sample string 13",
  "CreatedDate": "2026-07-31T00:10:24.1470614Z",
  "CreatedBy": {
    "Initials": "sample string 1",
    "ContactName": "sample string 2",
    "Gender": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Title": "sample string 3",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "PrimaryTelephone": {
      "Type": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Value": "sample string 1",
      "Notes": "sample string 2",
      "ContactOrder": 3,
      "AllowContact": true,
      "MarketingContactStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Name": "sample string 5",
      "Id": 6
    },
    "PrimaryEmail": {
      "Type": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Value": "sample string 1",
      "Notes": "sample string 2",
      "ContactOrder": 3,
      "AllowContact": true,
      "MarketingContactStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Name": "sample string 5",
      "Id": 6
    },
    "JobTitle": "sample string 6",
    "Id": 7
  },
  "Id": 15
}

Response Information

Resource Description

The response returned after the operation completes.

AddressDataContract

Name	Description	Type	Additional information
Location	The location value.	LocationDataContract	None.
AddressSource	The address source value.	EnumDataContract	None.
SourceId	The unique identifier of the related source resource.	string	None.
OrganizationName	The organization name value.	string	None.
Number	The number value.	string	None.
BuildingName	The building name value.	string	None.
Street	The street value.	string	None.
Town	The town value.	string	None.
Locality	The locality value.	string	None.
County	The county value.	string	None.
Country	The country value.	string	None.
Postcode	The postcode value.	string	None.
Uprn	The uprn value.	string	None.
CreatedDate	The created date, expressed as a date and time.	date	None.
CreatedBy	The created by value.	CreatedByDataContract	None.
Id	The unique identifier of this resource.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Location": {
    "CenterPoint": {
      "Latitude": 1.1,
      "Longitude": 2.1,
      "Altitude": 3.1,
      "Order": 4,
      "Id": 5
    },
    "Extent": [
      {
        "Latitude": 1.1,
        "Longitude": 2.1,
        "Altitude": 3.1,
        "Order": 4,
        "Id": 5
      },
      {
        "Latitude": 1.1,
        "Longitude": 2.1,
        "Altitude": 3.1,
        "Order": 4,
        "Id": 5
      }
    ],
    "ViewPoints": [
      {
        "Point": {
          "Latitude": 1.1,
          "Longitude": 2.1,
          "Altitude": 3.1,
          "Order": 4,
          "Id": 5
        },
        "Pitch": 1.1,
        "Heading": 2.1,
        "FieldOfVision": 3.1,
        "Zoom": 4.1,
        "Label": "sample string 5",
        "Id": 6
      },
      {
        "Point": {
          "Latitude": 1.1,
          "Longitude": 2.1,
          "Altitude": 3.1,
          "Order": 4,
          "Id": 5
        },
        "Pitch": 1.1,
        "Heading": 2.1,
        "FieldOfVision": 3.1,
        "Zoom": 4.1,
        "Label": "sample string 5",
        "Id": 6
      }
    ],
    "Id": 1
  },
  "AddressSource": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "SourceId": "sample string 1",
  "OrganizationName": "sample string 2",
  "Number": "sample string 3",
  "BuildingName": "sample string 4",
  "Street": "sample string 5",
  "Town": "sample string 6",
  "Locality": "sample string 7",
  "County": "sample string 8",
  "Country": "sample string 9",
  "Postcode": "sample string 10",
  "Uprn": "sample string 11",
  "CreatedDate": "2026-07-31T00:10:24.1470614Z",
  "CreatedBy": {
    "Initials": "sample string 1",
    "ContactName": "sample string 2",
    "Gender": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Title": "sample string 3",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "PrimaryTelephone": {
      "Type": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Value": "sample string 1",
      "Notes": "sample string 2",
      "ContactOrder": 3,
      "AllowContact": true,
      "MarketingContactStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Name": "sample string 5",
      "Id": 6
    },
    "PrimaryEmail": {
      "Type": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Value": "sample string 1",
      "Notes": "sample string 2",
      "ContactOrder": 3,
      "AllowContact": true,
      "MarketingContactStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Name": "sample string 5",
      "Id": 6
    },
    "JobTitle": "sample string 6",
    "Id": 7
  },
  "Id": 13
}