Delete Property Group

DELETE

https://api.fortresstech.io/v1/propertyGroups/:propertyGroupId

DELETE

/v1/propertyGroups/:propertyGroupId

curl -X DELETE https://api.fortresstech.io/v1/propertyGroups/propertyGroupId \
     -H "x-api-key: <apiKey>"

200Deleted

{
  "name": "string",
  "description": "string",
  "propertyIds": [
    "string"
  ],
  "organizationId": "string",
  "id": "string",
  "readableId": "string",
  "idempotencyId": "string",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "deletedAt": "2024-01-15T09:30:00Z",
  "properties": [
    {
      "name": "string",
      "shortName": "string",
      "email": "string",
      "phone": "string",
      "physicalStreetAddress1": "string",
      "physicalStreetAddress2": "string",
      "physicalCity": "string",
      "physicalState": "string",
      "physicalZip": "string",
      "physicalCountry": "string",
      "mailingStreetAddress1": "string",
      "mailingStreetAddress2": "string",
      "mailingCity": "string",
      "mailingState": "string",
      "mailingZip": "string",
      "mailingCountry": "string",
      "phoneNumber": "string",
      "faxNumber": "string",
      "timezone": "string",
      "longitude": 1.1,
      "latitude": 1.1,
      "turnMoveOutDays": 1,
      "status": "ACTIVE",
      "propertyClass": "Conventional",
      "organizationId": "string",
      "id": "string",
      "readableId": "string",
      "idempotencyId": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "offboardedAt": "2024-01-15T09:30:00Z",
      "countyName": "string",
      "acquisitionDate": "2024-01-15T09:30:00Z"
    }
  ]
}

Available by Request

Remove a property group from the system. Note that this does not delete the properties themselves, only the grouping structure.

This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

propertyGroupIdstringRequired

The id of the property group

Response

Expected response to a valid request

namestring

descriptionstringOptional

propertyIdslist of stringsOptional

organizationIdstringOptionalformat: "uuid"

idstringOptionalformat: "uuid"

readableIdstringOptional

idempotencyIdstringOptionalformat: "uuid"

createdAtdatetimeOptional

updatedAtdatetimeOptional

deletedAtdatetimeOptional

propertieslist of objectsOptional