PATCH
/
units
/
{id}
curl --request PATCH \
  --url https://app.planpoint.io/api/units/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "_id": "<string>",
  "floor": "<string>",
  "name": "<string>",
  "bedrooms": "<string>",
  "squareFeet": 123,
  "isFeatured": false,
  "price": 123,
  "unitPriceTBD": false,
  "type": "<string>",
  "specificType": "<string>",
  "availability": "<string>",
  "path": "<string>",
  "lotPath": "<string>",
  "unitImageUrl": "<string>",
  "onHoldExpiresAt": "2023-11-07T05:31:56Z",
  "layoutUrl": "<string>",
  "layoutGallery": [
    "<string>"
  ],
  "downloadableAsset": "<string>",
  "brochurePDF": "<string>",
  "additionalInfo": [
    {
      "label": "<string>",
      "value": "<string>"
    }
  ],
  "embedCode": "<string>",
  "customButtonUrl": "",
  "payableAmount": 123,
  "customButtonSnippet": "",
  "images": [
    "<string>"
  ],
  "clonedImages": [
    "<string>"
  ],
  "customFinishes": {
    "type": {
      "name": "<string>",
      "options": {
        "kitchen": {
          "tabs": [
            {
              "label": "<string>",
              "cover": "<string>",
              "thumbnail": "<string>"
            }
          ]
        },
        "bathroom": {
          "tabs": [
            {
              "label": "<string>",
              "cover": "<string>",
              "thumbnail": "<string>"
            }
          ]
        },
        "general": {
          "tabs": [
            {
              "label": "<string>",
              "cover": "<string>",
              "thumbnail": "<string>"
            }
          ]
        }
      }
    },
    "default": {}
  },
  "finishes": [
    "<string>"
  ],
  "clonedFinishes": [
    "<string>"
  ],
  "parking": 123,
  "bathrooms": 123,
  "orientation": "<string>",
  "inclusions": "<string>",
  "deliveryDate": "<string>",
  "description": "<string>",
  "unitmodels": [
    "<string>"
  ],
  "lon": -93.75940812944683,
  "lat": 43.75940812944682,
  "perimeter": "<string>",
  "svgLotId": "<string>"
}'
{
  "_id": "<string>",
  "floor": "<string>",
  "name": "<string>",
  "bedrooms": "<string>",
  "squareFeet": 123,
  "isFeatured": false,
  "price": 123,
  "unitPriceTBD": false,
  "type": "<string>",
  "specificType": "<string>",
  "availability": "<string>",
  "path": "<string>",
  "lotPath": "<string>",
  "unitImageUrl": "<string>",
  "onHoldExpiresAt": "2023-11-07T05:31:56Z",
  "layoutUrl": "<string>",
  "layoutGallery": [
    "<string>"
  ],
  "downloadableAsset": "<string>",
  "brochurePDF": "<string>",
  "additionalInfo": [
    {
      "label": "<string>",
      "value": "<string>"
    }
  ],
  "embedCode": "<string>",
  "customButtonUrl": "",
  "payableAmount": 123,
  "customButtonSnippet": "",
  "images": [
    "<string>"
  ],
  "clonedImages": [
    "<string>"
  ],
  "customFinishes": {
    "type": {
      "name": "<string>",
      "options": {
        "kitchen": {
          "tabs": [
            {
              "label": "<string>",
              "cover": "<string>",
              "thumbnail": "<string>"
            }
          ]
        },
        "bathroom": {
          "tabs": [
            {
              "label": "<string>",
              "cover": "<string>",
              "thumbnail": "<string>"
            }
          ]
        },
        "general": {
          "tabs": [
            {
              "label": "<string>",
              "cover": "<string>",
              "thumbnail": "<string>"
            }
          ]
        }
      }
    },
    "default": {}
  },
  "finishes": [
    "<string>"
  ],
  "clonedFinishes": [
    "<string>"
  ],
  "parking": 123,
  "bathrooms": 123,
  "orientation": "<string>",
  "inclusions": "<string>",
  "deliveryDate": "<string>",
  "description": "<string>",
  "unitmodels": [
    "<string>"
  ],
  "lon": -93.75940812944683,
  "lat": 43.75940812944682,
  "perimeter": "<string>",
  "svgLotId": "<string>"
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
id
string
required

Unit ID

Example:

"objectId"

Body

Update an existing unit
​
_id
string

Unique identifier for the unit

​
floor
string

Reference to the associated floor

​
name
string

Name of the unit

​
bedrooms
string

Number of bedrooms in the unit

​
squareFeet
number

Square footage of the unit

​
isFeatured
boolean
default:false

Indicates if the unit is featured

​
price
number

Price of the unit

​
unitPriceTBD
boolean
default:false

Indicates if the unit price is to be determined

​
type
string

Type of the unit

​
specificType
string

Specific type, e.g., 'Amenities', 'Parkings'. Defaults to 'unit' if not specified

​
availability
string

Availability status of the unit

​
path
string

Path for unit details

​
lotPath
string

Path for the lot associated with the unit

​
unitImageUrl
string

URL of the unit's image

​
onHoldExpiresAt
string

Expiration date for the unit's hold status

​
layoutUrl
string

URL of the unit layout

​
layoutGallery
string[]

Gallery of layout images

​
downloadableAsset
string

URL of a downloadable asset

​
brochurePDF
string

URL of the brochure in PDF format

​
additionalInfo
object[]

List of additional information

​
embedCode
string

Embed code for the unit

​
customButtonUrl
string
default:

Custom URL for the unit's button

​
payableAmount
number

Payable amount for the unit

​
customButtonSnippet
string
default:

Custom snippet for the unit's button

​
images
string[]

List of image URLs

​
clonedImages
string[]

List of cloned image URLs

​
customFinishes
object
​
finishes
string[]

List of finishes

​
clonedFinishes
string[]

List of cloned finishes

​
parking
number

Number of parking spaces

​
bathrooms
number

Number of bathrooms

​
orientation
string

Orientation of the unit

​
inclusions
string

Inclusions for the unit

​
deliveryDate
string

Expected delivery date

​
description
string

Description of the unit

​
unitmodels
string[]

References to associated unit models

​
lon
number

Longitude of the unit location.

Example:

-93.75940812944683

​
lat
number

Latitude of the unit location.

Example:

43.75940812944682

​
perimeter
string

Perimeter of the unit

​
svgLotId
string

SVG ID for the lot

Response

200
application/json
Successful operation
​
_id
string

Unique identifier for the unit

​
floor
string

Reference to the associated floor

​
name
string

Name of the unit

​
bedrooms
string

Number of bedrooms in the unit

​
squareFeet
number

Square footage of the unit

​
isFeatured
boolean
default:false

Indicates if the unit is featured

​
price
number

Price of the unit

​
unitPriceTBD
boolean
default:false

Indicates if the unit price is to be determined

​
type
string

Type of the unit

​
specificType
string

Specific type, e.g., 'Amenities', 'Parkings'. Defaults to 'unit' if not specified

​
availability
string

Availability status of the unit

​
path
string

Path for unit details

​
lotPath
string

Path for the lot associated with the unit

​
unitImageUrl
string

URL of the unit's image

​
onHoldExpiresAt
string

Expiration date for the unit's hold status

​
layoutUrl
string

URL of the unit layout

​
layoutGallery
string[]

Gallery of layout images

​
downloadableAsset
string

URL of a downloadable asset

​
brochurePDF
string

URL of the brochure in PDF format

​
additionalInfo
object[]

List of additional information

​
embedCode
string

Embed code for the unit

​
customButtonUrl
string
default:

Custom URL for the unit's button

​
payableAmount
number

Payable amount for the unit

​
customButtonSnippet
string
default:

Custom snippet for the unit's button

​
images
string[]

List of image URLs

​
clonedImages
string[]

List of cloned image URLs

​
customFinishes
object
​
finishes
string[]

List of finishes

​
clonedFinishes
string[]

List of cloned finishes

​
parking
number

Number of parking spaces

​
bathrooms
number

Number of bathrooms

​
orientation
string

Orientation of the unit

​
inclusions
string

Inclusions for the unit

​
deliveryDate
string

Expected delivery date

​
description
string

Description of the unit

​
unitmodels
string[]

References to associated unit models

​
lon
number

Longitude of the unit location.

Example:

-93.75940812944683

​
lat
number

Latitude of the unit location.

Example:

43.75940812944682

​
perimeter
string

Perimeter of the unit

​
svgLotId
string

SVG ID for the lot

Create UnitDelete Unit