POST api/property/add

Add Property. Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The add property command data contract supplied with the request.

AddPropertyCommandDataContract

Name	Description	Type	Additional information
Property	The property value.	PropertyCommandDataContract	None.
AmenityDescription	The amenity description value.	BookValuationAmenityDescriptionCommandDataContract	None.
RoomCountDescription	The room count description value.	BookValuationRoomCountDescriptionCommandDataContract	None.
StyleAgeDescription	The style age description value.	BookValuationStyleAgeDescriptionCommandDataContract	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "Property": {
    "Address": {
      "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-23T08:15:29.1616313Z",
      "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
    },
    "Id": 1
  },
  "AmenityDescription": {
    "Gardens": 1,
    "ParkingSpaces": 2,
    "ParkingTypes": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    ],
    "Garages": 3,
    "FixturesFittings": "sample string 4",
    "Acreage": 5.1,
    "AcreageMeasurementUnitType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "AccessibilityTypes": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    ],
    "HeatingSources": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    ],
    "ElectricitySupply": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    ],
    "WaterSupply": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Sewerage": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "BroadbandConnectionTypes": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    ],
    "Name": "sample string 6",
    "Id": 7
  },
  "RoomCountDescription": {
    "Bedrooms": 1,
    "Bathrooms": 2,
    "Receptions": 3,
    "Others": 4,
    "Conservatories": 5,
    "Extensions": 6,
    "Name": "sample string 7",
    "Id": 8
  },
  "StyleAgeDescription": {
    "PropertyType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "StyleType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "LeaseType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "AgeType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Name": "sample string 1",
    "Id": 2
  }
}

Response Information

Resource Description

The response returned after the operation completes.

PropertyDataContract

Name	Description	Type	Additional information
Address	The address value.	AddressDataContract	None.
Keys	The collection of keys.	Collection of PropertyKeyDataContract	None.
Alarms	The collection of alarms.	Collection of PropertyAlarmDataContract	None.
Roles	The collection of roles.	Collection of RoleDataContract	None.
InactiveRoleIds	The unique identifiers of the related inactive role resources.	Collection of integer	None.
SpecialArrangements	The collection of special arrangements.	Collection of PropertySpecialArrangementDataContract	None.
SystemStatusName	The system status name value.	string	None.
Certificates	The collection of certificates.	Collection of PropertyCertificateDataContract	None.
DefaultPicture	The default picture value.	DocumentDataContract	None.
CustomFields	The collection of custom fields.	Collection of CustomFieldGroupWithValuesDataContract	None.
RetentionAmount	The retention amount value.	decimal number	None.
PreApprovedSpendAmount	The pre approved spend amount value.	decimal number	None.
Id	The unique identifier of this resource.	integer	None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.