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

The body is of type object.

Response

200
application/json
Successful operation

The response is of type object.