PATCH
/
project
/
{id}
curl --request PATCH \
  --url https://app.planpoint.io/api/project/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "_id": "objectId",
  "user": "objectId",
  "floors": [
    "objectId"
  ],
  "commercialSpaces": [
    "objectId"
  ],
  "name": "<string>",
  "websiteURL": "<string>",
  "internalURL": "<string>",
  "accentColor": "<string>",
  "showInclusions": true,
  "showBathrooms": true,
  "showAdditionalInfo": true,
  "showParking": true,
  "showOrientation": true,
  "brochureButtonEnabled": true,
  "brochureAssets": [
    "<string>"
  ],
  "customButtonEnabled": true,
  "customButtonOpensAt": "same_tab",
  "walkscoreEnabled": true,
  "walkscore": "<string>",
  "customButtonText": "<string>",
  "customButtonIcon": "<string>",
  "showAvailability": true,
  "hideSold": true,
  "showPrices": true,
  "initialView": "List",
  "gtmEnabled": false,
  "dayNightEnabled": false,
  "showAvailableFirst": false,
  "gtmHeadCode": "",
  "gtmBodyCode": "",
  "unitImageOnGrid": "Unit Plan",
  "skipFloorStep": false,
  "areaUnit": "<string>",
  "showUnitCustomFinishes": false,
  "showFloorOverview": false,
  "pricesStartingAt": false,
  "showPriceFilter": true,
  "showAreaFilter": true,
  "showUnitDescription": false,
  "showTaxes": true,
  "sharePageEnabled": true,
  "sharePageDescription": "<string>",
  "sharePageLogo": "<string>",
  "priceBeforeTax": true,
  "enableForms": true,
  "rentalObject": true,
  "deliveryDates": true,
  "hideArea": false,
  "showBranding": true,
  "projectImageUrl": "<string>",
  "alternativeCovers": [
    "<string>"
  ],
  "customButtonActionType": "url",
  "projectSVGUrl": "<string>",
  "svgGroupId": "<string>",
  "layoutImageUrl": "<string>",
  "formsSendTo": "<string>",
  "formsSubject": "<string>",
  "formsFromName": "<string>",
  "formsMessage": "<string>",
  "formsRedirectURL": "<string>",
  "namespace": "<string>",
  "hostName": "<string>",
  "projectLang": "<string>",
  "projectType": "<string>",
  "propertyType": "<string>",
  "lotsLayout": "<string>",
  "areaDescription": "<string>",
  "enterpriseAddressDisplay": "<string>",
  "similarSortingBy": "default",
  "onHoldExperienceEnabled": false,
  "onHoldMinsDuration": 5,
  "customFormEnabled": false,
  "customFormFields": [],
  "crfMessage": "<string>",
  "mapLayoutWidth": 123,
  "mapLayoutRotation": 123,
  "previewMode": false,
  "landOnly": false,
  "showUnitFinishes": false,
  "showVariants": false,
  "administrators": [
    "objectId"
  ],
  "editors": [
    "objectId"
  ],
  "globalAmount": 123,
  "chargeType": "same",
  "chargeDescription": "",
  "chargeCurrency": "usd",
  "payButtonText": "Pay Now",
  "payButtonIcon": "",
  "invites": [
    {
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "<string>",
      "level": "<string>"
    }
  ],
  "leads": [
    {
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "unit": "<string>",
      "message": "<string>",
      "source": "<string>",
      "createdAt": "<string>",
      "questions": [
        {
          "question": "<string>",
          "answer": "<string>"
        }
      ],
      "customFields": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "waitlistees": [
    {
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "unit": "<string>",
      "createdAt": "<string>"
    }
  ],
  "allocations": [
    {
      "name": "<string>",
      "password": "<string>",
      "allocation": "<string>"
    }
  ],
  "images": [
    "<string>"
  ],
  "finishes": [
    "<string>"
  ],
  "customFinishes": {
    "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>"
          }
        ]
      }
    }
  },
  "sponsorsEnabled": false,
  "waitlistEnabled": false,
  "sponsors": "<string>",
  "layouts": "<string>",
  "downloadableAssets": "<string>",
  "floorplans": "<string>",
  "plan": {},
  "path": "<string>",
  "alternativePaths": "<string>",
  "invertNav": false,
  "address": "<string>",
  "lon": -93.75940812944683,
  "lat": 43.75940812944682,
  "zoomLevel": 0,
  "perimeter": "<string>",
  "markerImageUrl": "<string>",
  "targetMarker": "<string>",
  "mapStyle": "Light",
  "mapPointColor": "<string>",
  "mapDirections": false,
  "calUsername": "<string>",
  "calKey": "<string>",
  "payPalClientId": "<string>",
  "payPalDeposit": 123,
  "payPalCurrency": "<string>",
  "yiApiToken": "<string>",
  "yiCompanyCode": "<string>",
  "yiPropertyCode": "<string>",
  "yiStatusMapping": {
    "available": "<string>",
    "leased": "<string>",
    "sold": "<string>",
    "unavailable": "<string>",
    "reserved": "<string>"
  },
  "pvUsername": "<string>",
  "pvPassword": "<string>",
  "pvBuildingName": "<string>",
  "zhClientId": "<string>",
  "zhAccessToken": "<string>",
  "zhClientSecret": "<string>",
  "zhOrgId": "<string>",
  "srToken": "<string>",
  "srBaseUrl": "<string>",
  "sfProjectId": "<string>",
  "sfKey": "<string>",
  "sfSecret": "<string>",
  "soProjectId": "<string>",
  "soKey": "<string>",
  "soSecret": "<string>",
  "soDomain": "<string>",
  "bsBuildingId": "<string>",
  "bsUsername": "<string>",
  "bsPassword": "<string>",
  "ftpUrl": "<string>",
  "ftpPort": 123,
  "ftpUsername": "<string>",
  "ftpPassword": "<string>",
  "ftpWhitelist": "<string>",
  "ftpBlacklist": "<string>",
  "ftpPath": "<string>",
  "ftpFileName": "<string>",
  "ftpMapping": [
    {
      "header": "<string>",
      "property": "<string>"
    }
  ],
  "colorBase": "<string>",
  "colorAccent": "<string>",
  "colorHover": "<string>",
  "colorButton": "<string>",
  "colorButtonText": "<string>",
  "colorText": "<string>",
  "colorFeatured": "<string>",
  "colorSold": "<string>",
  "colorAvailable": "<string>",
  "colorReserved": "<string>",
  "styleNavigation": "<string>",
  "styleBranding": "<string>",
  "styleFilter": "<string>",
  "styleShapes": "<string>",
  "styleFont": "<string>",
  "subscriptionItem": "<string>",
  "lastSync": "<string>",
  "lockScreen": false,
  "specialRankEnabled": false,
  "priorityList": false,
  "lockScreenName": true,
  "lockScreenEmail": true,
  "lockScreenPhone": true,
  "lockScreenMessage": true,
  "lockScreenCustom": false,
  "lockScreenCustomQuestions": [
    {
      "lang": "<string>",
      "value": "<string>"
    }
  ],
  "_3dModelUrl": "<string>",
  "reportSendTo": "<string>",
  "eventsBlockList": "<string>",
  "excludeBlockedEvents": true,
  "enable3d": false,
  "_3dBuildingModelUrl": "<string>",
  "_3dFloorSelectorModelUrl": "<string>",
  "phasePrefix": "<string>",
  "hideGallery": true,
  "hideBedrooms": true
}'
{
  "_id": "objectId",
  "user": "objectId",
  "floors": [
    "objectId"
  ],
  "commercialSpaces": [
    "objectId"
  ],
  "name": "<string>",
  "websiteURL": "<string>",
  "internalURL": "<string>",
  "accentColor": "<string>",
  "showInclusions": true,
  "showBathrooms": true,
  "showAdditionalInfo": true,
  "showParking": true,
  "showOrientation": true,
  "brochureButtonEnabled": true,
  "brochureAssets": [
    "<string>"
  ],
  "customButtonEnabled": true,
  "customButtonOpensAt": "same_tab",
  "walkscoreEnabled": true,
  "walkscore": "<string>",
  "customButtonText": "<string>",
  "customButtonIcon": "<string>",
  "showAvailability": true,
  "hideSold": true,
  "showPrices": true,
  "initialView": "List",
  "gtmEnabled": false,
  "dayNightEnabled": false,
  "showAvailableFirst": false,
  "gtmHeadCode": "",
  "gtmBodyCode": "",
  "unitImageOnGrid": "Unit Plan",
  "skipFloorStep": false,
  "areaUnit": "<string>",
  "showUnitCustomFinishes": false,
  "showFloorOverview": false,
  "pricesStartingAt": false,
  "showPriceFilter": true,
  "showAreaFilter": true,
  "showUnitDescription": false,
  "showTaxes": true,
  "sharePageEnabled": true,
  "sharePageDescription": "<string>",
  "sharePageLogo": "<string>",
  "priceBeforeTax": true,
  "enableForms": true,
  "rentalObject": true,
  "deliveryDates": true,
  "hideArea": false,
  "showBranding": true,
  "projectImageUrl": "<string>",
  "alternativeCovers": [
    "<string>"
  ],
  "customButtonActionType": "url",
  "projectSVGUrl": "<string>",
  "svgGroupId": "<string>",
  "layoutImageUrl": "<string>",
  "formsSendTo": "<string>",
  "formsSubject": "<string>",
  "formsFromName": "<string>",
  "formsMessage": "<string>",
  "formsRedirectURL": "<string>",
  "namespace": "<string>",
  "hostName": "<string>",
  "projectLang": "<string>",
  "projectType": "<string>",
  "propertyType": "<string>",
  "lotsLayout": "<string>",
  "areaDescription": "<string>",
  "enterpriseAddressDisplay": "<string>",
  "similarSortingBy": "default",
  "onHoldExperienceEnabled": false,
  "onHoldMinsDuration": 5,
  "customFormEnabled": false,
  "customFormFields": [],
  "crfMessage": "<string>",
  "mapLayoutWidth": 123,
  "mapLayoutRotation": 123,
  "previewMode": false,
  "landOnly": false,
  "showUnitFinishes": false,
  "showVariants": false,
  "administrators": [
    "objectId"
  ],
  "editors": [
    "objectId"
  ],
  "globalAmount": 123,
  "chargeType": "same",
  "chargeDescription": "",
  "chargeCurrency": "usd",
  "payButtonText": "Pay Now",
  "payButtonIcon": "",
  "invites": [
    {
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "<string>",
      "level": "<string>"
    }
  ],
  "leads": [
    {
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "unit": "<string>",
      "message": "<string>",
      "source": "<string>",
      "createdAt": "<string>",
      "questions": [
        {
          "question": "<string>",
          "answer": "<string>"
        }
      ],
      "customFields": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "waitlistees": [
    {
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "unit": "<string>",
      "createdAt": "<string>"
    }
  ],
  "allocations": [
    {
      "name": "<string>",
      "password": "<string>",
      "allocation": "<string>"
    }
  ],
  "images": [
    "<string>"
  ],
  "finishes": [
    "<string>"
  ],
  "customFinishes": {
    "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>"
          }
        ]
      }
    }
  },
  "sponsorsEnabled": false,
  "waitlistEnabled": false,
  "sponsors": "<string>",
  "layouts": "<string>",
  "downloadableAssets": "<string>",
  "floorplans": "<string>",
  "plan": {},
  "path": "<string>",
  "alternativePaths": "<string>",
  "invertNav": false,
  "address": "<string>",
  "lon": -93.75940812944683,
  "lat": 43.75940812944682,
  "zoomLevel": 0,
  "perimeter": "<string>",
  "markerImageUrl": "<string>",
  "targetMarker": "<string>",
  "mapStyle": "Light",
  "mapPointColor": "<string>",
  "mapDirections": false,
  "calUsername": "<string>",
  "calKey": "<string>",
  "payPalClientId": "<string>",
  "payPalDeposit": 123,
  "payPalCurrency": "<string>",
  "yiApiToken": "<string>",
  "yiCompanyCode": "<string>",
  "yiPropertyCode": "<string>",
  "yiStatusMapping": {
    "available": "<string>",
    "leased": "<string>",
    "sold": "<string>",
    "unavailable": "<string>",
    "reserved": "<string>"
  },
  "pvUsername": "<string>",
  "pvPassword": "<string>",
  "pvBuildingName": "<string>",
  "zhClientId": "<string>",
  "zhAccessToken": "<string>",
  "zhClientSecret": "<string>",
  "zhOrgId": "<string>",
  "srToken": "<string>",
  "srBaseUrl": "<string>",
  "sfProjectId": "<string>",
  "sfKey": "<string>",
  "sfSecret": "<string>",
  "soProjectId": "<string>",
  "soKey": "<string>",
  "soSecret": "<string>",
  "soDomain": "<string>",
  "bsBuildingId": "<string>",
  "bsUsername": "<string>",
  "bsPassword": "<string>",
  "ftpUrl": "<string>",
  "ftpPort": 123,
  "ftpUsername": "<string>",
  "ftpPassword": "<string>",
  "ftpWhitelist": "<string>",
  "ftpBlacklist": "<string>",
  "ftpPath": "<string>",
  "ftpFileName": "<string>",
  "ftpMapping": [
    {
      "header": "<string>",
      "property": "<string>"
    }
  ],
  "colorBase": "<string>",
  "colorAccent": "<string>",
  "colorHover": "<string>",
  "colorButton": "<string>",
  "colorButtonText": "<string>",
  "colorText": "<string>",
  "colorFeatured": "<string>",
  "colorSold": "<string>",
  "colorAvailable": "<string>",
  "colorReserved": "<string>",
  "styleNavigation": "<string>",
  "styleBranding": "<string>",
  "styleFilter": "<string>",
  "styleShapes": "<string>",
  "styleFont": "<string>",
  "subscriptionItem": "<string>",
  "lastSync": "<string>",
  "lockScreen": false,
  "specialRankEnabled": false,
  "priorityList": false,
  "lockScreenName": true,
  "lockScreenEmail": true,
  "lockScreenPhone": true,
  "lockScreenMessage": true,
  "lockScreenCustom": false,
  "lockScreenCustomQuestions": [
    {
      "lang": "<string>",
      "value": "<string>"
    }
  ],
  "_3dModelUrl": "<string>",
  "reportSendTo": "<string>",
  "eventsBlockList": "<string>",
  "excludeBlockedEvents": true,
  "enable3d": false,
  "_3dBuildingModelUrl": "<string>",
  "_3dFloorSelectorModelUrl": "<string>",
  "phasePrefix": "<string>",
  "hideGallery": true,
  "hideBedrooms": true
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
id
string
required

Project ID

Example:

"objectId"

Body

Update an existing project
​
_id
string

Unique identifier for the project.

Example:

"objectId"

​
user
string

Reference to the User associated with the project.

Example:

"objectId"

​
floors
string[]

List of references to Floor documents.

​
commercialSpaces
string[]

List of references to CommercialSpace documents.

​
name
string

Name of the project.

​
websiteURL
string

Website URL of the project.

​
internalURL
string

Internal URL for project management.

​
accentColor
string

Accent color for the project branding.

​
showInclusions
boolean

Whether inclusions are displayed in the project.

​
showBathrooms
boolean

Whether bathrooms are displayed in the project.

​
showAdditionalInfo
boolean

Whether additional information is displayed in the project.

​
showParking
boolean

Whether parking information is displayed.

​
showOrientation
boolean

Whether orientation information is displayed.

​
brochureButtonEnabled
boolean

Whether the brochure button is enabled.

​
brochureAssets
string[]

List of brochure asset URLs.

​
customButtonEnabled
boolean

Whether a custom button is enabled.

​
customButtonOpensAt
string
default:same_tab

Specifies where the custom button opens.

​
walkscoreEnabled
boolean

Whether Walkscore integration is enabled.

​
walkscore
string

Walkscore of the project.

​
customButtonText
string

Text for the custom button.

​
customButtonIcon
string

Icon for the custom button.

​
showAvailability
boolean

Whether availability is displayed.

​
hideSold
boolean

Whether sold units are hidden.

​
showPrices
boolean

Whether prices are displayed.

​
initialView
string
default:List

Initial view mode of the project.

​
gtmEnabled
boolean
default:false

Whether Google Tag Manager is enabled.

​
dayNightEnabled
boolean
default:false

Whether day-night mode is enabled.

​
showAvailableFirst
boolean
default:false

Whether available units are shown first.

​
gtmHeadCode
string
default:

Google Tag Manager head code.

​
gtmBodyCode
string
default:

Google Tag Manager body code.

​
unitImageOnGrid
string
default:Unit Plan

Type of unit image displayed on the grid.

​
skipFloorStep
boolean
default:false

Whether the floor step is skipped in navigation.

​
areaUnit
string

Unit of measurement for area.

​
showUnitCustomFinishes
boolean
default:false

Whether custom finishes for units are shown.

​
showFloorOverview
boolean
default:false

Whether the floor overview is displayed.

​
pricesStartingAt
boolean
default:false

Whether prices display as 'starting at'.

​
showPriceFilter
boolean
default:true

Whether the price filter is displayed.

​
showAreaFilter
boolean
default:true

Whether the area filter is displayed.

​
showUnitDescription
boolean
default:false

Whether unit descriptions are displayed.

​
showTaxes
boolean

Whether taxes are displayed.

​
sharePageEnabled
boolean

Whether the share page feature is enabled.

​
sharePageDescription
string

Description for the share page.

Logo for the share page.

​
priceBeforeTax
boolean

Whether prices are shown before tax.

​
enableForms
boolean
default:true

Whether forms are enabled for the project.

​
rentalObject
boolean

Whether the project is a rental property.

​
deliveryDates
boolean

Whether delivery dates are displayed.

​
hideArea
boolean
default:false

Whether the area information is hidden.

​
showBranding
boolean
default:true

Whether branding is shown on the project page.

​
projectImageUrl
string

URL of the project's main image.

​
alternativeCovers
string[]

List of alternative cover images for the project.

​
customButtonActionType
string
default:url

Action type for the custom button.

​
projectSVGUrl
string

URL for the project's SVG.

​
svgGroupId
string

Group ID in the project's SVG.

​
layoutImageUrl
string

URL for the project's layout image.

​
formsSendTo
string

Email address to send forms to.

​
formsSubject
string

Subject line for forms submissions.

​
formsFromName
string

Sender name for forms submissions.

​
formsMessage
string

Default message for forms submissions.

​
formsRedirectURL
string

URL to redirect after forms submission.

​
namespace
string

Namespace for the project.

​
hostName
string

Host name for the project.

​
projectLang
string

Language for the project.

​
projectType
string

Type of project.

​
propertyType
string

Property type of the project.

​
lotsLayout
string

Layout for lots in the project.

​
areaDescription
string

Description for the area.

​
enterpriseAddressDisplay
string

Enterprise address display details.

​
similarSortingBy
string
default:default

Method of sorting for similar items.

​
onHoldExperienceEnabled
boolean
default:false

Whether the on-hold experience is enabled.

​
onHoldMinsDuration
number
default:5

Duration (in minutes) for on-hold experience.

​
customFormEnabled
boolean
default:false

Whether custom forms are enabled.

​
customFormFields
string[]

List of custom form fields.

​
crfMessage
string

Custom form message.

​
mapLayoutWidth
number

Width for the map layout.

​
mapLayoutRotation
number

Rotation for the map layout.

​
previewMode
boolean
default:false

Whether preview mode is enabled.

​
landOnly
boolean
default:false

Whether the project is for land only.

​
showUnitFinishes
boolean
default:false

Whether unit finishes are displayed.

​
showVariants
boolean
default:false

Whether unit variants are displayed.

​
administrators
string[]

List of administrator user IDs.

​
editors
string[]

List of editor user IDs.

​
globalAmount
number

Global amount for the project.

​
chargeType
string
default:same

Charge type for the project.

​
chargeDescription
string
default:

Description for the charge.

​
chargeCurrency
string
default:usd

Currency for charges.

​
payButtonText
string
default:Pay Now

Text for the payment button.

​
payButtonIcon
string
default:

Icon for the payment button.

​
invites
object[]

List of invite details.

​
leads
object[]

List of leads.

​
waitlistees
object[]
​
allocations
object[]
​
images
string[]
​
finishes
string[]
​
customFinishes
object
​
sponsorsEnabled
boolean
default:false
​
waitlistEnabled
boolean
default:false
​
sponsors
string
​
layouts
string
​
downloadableAssets
string
​
floorplans
string
​
plan
object
​
path
string
​
alternativePaths
string
​
invertNav
boolean
default:false
​
address
string
​
lon
number

Longitude of the project location.

Example:

-93.75940812944683

​
lat
number

Latitude of the project location.

Example:

43.75940812944682

​
zoomLevel
number
default:0
​
perimeter
string
​
markerImageUrl
string
​
targetMarker
string
​
mapStyle
string
default:Light
​
mapPointColor
string
​
mapDirections
boolean
default:false
​
calUsername
string
​
calKey
string
​
payPalClientId
string
​
payPalDeposit
number
​
payPalCurrency
string
​
yiApiToken
string
​
yiCompanyCode
string
​
yiPropertyCode
string
​
yiStatusMapping
object
​
pvUsername
string
​
pvPassword
string
​
pvBuildingName
string
​
zhClientId
string
​
zhAccessToken
string
​
zhClientSecret
string
​
zhOrgId
string
​
srToken
string
​
srBaseUrl
string
​
sfProjectId
string
​
sfKey
string
​
sfSecret
string
​
soProjectId
string
​
soKey
string
​
soSecret
string
​
soDomain
string
​
bsBuildingId
string
​
bsUsername
string
​
bsPassword
string
​
ftpUrl
string
​
ftpPort
number
​
ftpUsername
string
​
ftpPassword
string
​
ftpWhitelist
string
​
ftpBlacklist
string
​
ftpPath
string
​
ftpFileName
string
​
ftpMapping
object[]
​
colorBase
string
​
colorAccent
string
​
colorHover
string
​
colorButton
string
​
colorButtonText
string
​
colorText
string
​
colorFeatured
string
​
colorSold
string
​
colorAvailable
string
​
colorReserved
string
​
styleNavigation
string
​
styleBranding
string
​
styleFilter
string
​
styleShapes
string
​
styleFont
string
​
subscriptionItem
string
​
lastSync
string
​
lockScreen
boolean
default:false
​
specialRankEnabled
boolean
default:false
​
priorityList
boolean
default:false
​
lockScreenName
boolean
default:true
​
lockScreenEmail
boolean
default:true
​
lockScreenPhone
boolean
default:true
​
lockScreenMessage
boolean
default:true
​
lockScreenCustom
boolean
default:false
​
lockScreenCustomQuestions
object[]
​
_3dModelUrl
string
​
reportSendTo
string
​
eventsBlockList
string
​
excludeBlockedEvents
boolean
​
enable3d
boolean
default:false
​
_3dBuildingModelUrl
string
​
_3dFloorSelectorModelUrl
string
​
phasePrefix
string
​
hideGallery
boolean
​
hideBedrooms
boolean

Response

200
application/json
Successful operation
​
_id
string

Unique identifier for the project.

Example:

"objectId"

​
user
string

Reference to the User associated with the project.

Example:

"objectId"

​
floors
string[]

List of references to Floor documents.

​
commercialSpaces
string[]

List of references to CommercialSpace documents.

​
name
string

Name of the project.

​
websiteURL
string

Website URL of the project.

​
internalURL
string

Internal URL for project management.

​
accentColor
string

Accent color for the project branding.

​
showInclusions
boolean

Whether inclusions are displayed in the project.

​
showBathrooms
boolean

Whether bathrooms are displayed in the project.

​
showAdditionalInfo
boolean

Whether additional information is displayed in the project.

​
showParking
boolean

Whether parking information is displayed.

​
showOrientation
boolean

Whether orientation information is displayed.

​
brochureButtonEnabled
boolean

Whether the brochure button is enabled.

​
brochureAssets
string[]

List of brochure asset URLs.

​
customButtonEnabled
boolean

Whether a custom button is enabled.

​
customButtonOpensAt
string
default:same_tab

Specifies where the custom button opens.

​
walkscoreEnabled
boolean

Whether Walkscore integration is enabled.

​
walkscore
string

Walkscore of the project.

​
customButtonText
string

Text for the custom button.

​
customButtonIcon
string

Icon for the custom button.

​
showAvailability
boolean

Whether availability is displayed.

​
hideSold
boolean

Whether sold units are hidden.

​
showPrices
boolean

Whether prices are displayed.

​
initialView
string
default:List

Initial view mode of the project.

​
gtmEnabled
boolean
default:false

Whether Google Tag Manager is enabled.

​
dayNightEnabled
boolean
default:false

Whether day-night mode is enabled.

​
showAvailableFirst
boolean
default:false

Whether available units are shown first.

​
gtmHeadCode
string
default:

Google Tag Manager head code.

​
gtmBodyCode
string
default:

Google Tag Manager body code.

​
unitImageOnGrid
string
default:Unit Plan

Type of unit image displayed on the grid.

​
skipFloorStep
boolean
default:false

Whether the floor step is skipped in navigation.

​
areaUnit
string

Unit of measurement for area.

​
showUnitCustomFinishes
boolean
default:false

Whether custom finishes for units are shown.

​
showFloorOverview
boolean
default:false

Whether the floor overview is displayed.

​
pricesStartingAt
boolean
default:false

Whether prices display as 'starting at'.

​
showPriceFilter
boolean
default:true

Whether the price filter is displayed.

​
showAreaFilter
boolean
default:true

Whether the area filter is displayed.

​
showUnitDescription
boolean
default:false

Whether unit descriptions are displayed.

​
showTaxes
boolean

Whether taxes are displayed.

​
sharePageEnabled
boolean

Whether the share page feature is enabled.

​
sharePageDescription
string

Description for the share page.

Logo for the share page.

​
priceBeforeTax
boolean

Whether prices are shown before tax.

​
enableForms
boolean
default:true

Whether forms are enabled for the project.

​
rentalObject
boolean

Whether the project is a rental property.

​
deliveryDates
boolean

Whether delivery dates are displayed.

​
hideArea
boolean
default:false

Whether the area information is hidden.

​
showBranding
boolean
default:true

Whether branding is shown on the project page.

​
projectImageUrl
string

URL of the project's main image.

​
alternativeCovers
string[]

List of alternative cover images for the project.

​
customButtonActionType
string
default:url

Action type for the custom button.

​
projectSVGUrl
string

URL for the project's SVG.

​
svgGroupId
string

Group ID in the project's SVG.

​
layoutImageUrl
string

URL for the project's layout image.

​
formsSendTo
string

Email address to send forms to.

​
formsSubject
string

Subject line for forms submissions.

​
formsFromName
string

Sender name for forms submissions.

​
formsMessage
string

Default message for forms submissions.

​
formsRedirectURL
string

URL to redirect after forms submission.

​
namespace
string

Namespace for the project.

​
hostName
string

Host name for the project.

​
projectLang
string

Language for the project.

​
projectType
string

Type of project.

​
propertyType
string

Property type of the project.

​
lotsLayout
string

Layout for lots in the project.

​
areaDescription
string

Description for the area.

​
enterpriseAddressDisplay
string

Enterprise address display details.

​
similarSortingBy
string
default:default

Method of sorting for similar items.

​
onHoldExperienceEnabled
boolean
default:false

Whether the on-hold experience is enabled.

​
onHoldMinsDuration
number
default:5

Duration (in minutes) for on-hold experience.

​
customFormEnabled
boolean
default:false

Whether custom forms are enabled.

​
customFormFields
string[]

List of custom form fields.

​
crfMessage
string

Custom form message.

​
mapLayoutWidth
number

Width for the map layout.

​
mapLayoutRotation
number

Rotation for the map layout.

​
previewMode
boolean
default:false

Whether preview mode is enabled.

​
landOnly
boolean
default:false

Whether the project is for land only.

​
showUnitFinishes
boolean
default:false

Whether unit finishes are displayed.

​
showVariants
boolean
default:false

Whether unit variants are displayed.

​
administrators
string[]

List of administrator user IDs.

​
editors
string[]

List of editor user IDs.

​
globalAmount
number

Global amount for the project.

​
chargeType
string
default:same

Charge type for the project.

​
chargeDescription
string
default:

Description for the charge.

​
chargeCurrency
string
default:usd

Currency for charges.

​
payButtonText
string
default:Pay Now

Text for the payment button.

​
payButtonIcon
string
default:

Icon for the payment button.

​
invites
object[]

List of invite details.

​
leads
object[]

List of leads.

​
waitlistees
object[]
​
allocations
object[]
​
images
string[]
​
finishes
string[]
​
customFinishes
object
​
sponsorsEnabled
boolean
default:false
​
waitlistEnabled
boolean
default:false
​
sponsors
string
​
layouts
string
​
downloadableAssets
string
​
floorplans
string
​
plan
object
​
path
string
​
alternativePaths
string
​
invertNav
boolean
default:false
​
address
string
​
lon
number

Longitude of the project location.

Example:

-93.75940812944683

​
lat
number

Latitude of the project location.

Example:

43.75940812944682

​
zoomLevel
number
default:0
​
perimeter
string
​
markerImageUrl
string
​
targetMarker
string
​
mapStyle
string
default:Light
​
mapPointColor
string
​
mapDirections
boolean
default:false
​
calUsername
string
​
calKey
string
​
payPalClientId
string
​
payPalDeposit
number
​
payPalCurrency
string
​
yiApiToken
string
​
yiCompanyCode
string
​
yiPropertyCode
string
​
yiStatusMapping
object
​
pvUsername
string
​
pvPassword
string
​
pvBuildingName
string
​
zhClientId
string
​
zhAccessToken
string
​
zhClientSecret
string
​
zhOrgId
string
​
srToken
string
​
srBaseUrl
string
​
sfProjectId
string
​
sfKey
string
​
sfSecret
string
​
soProjectId
string
​
soKey
string
​
soSecret
string
​
soDomain
string
​
bsBuildingId
string
​
bsUsername
string
​
bsPassword
string
​
ftpUrl
string
​
ftpPort
number
​
ftpUsername
string
​
ftpPassword
string
​
ftpWhitelist
string
​
ftpBlacklist
string
​
ftpPath
string
​
ftpFileName
string
​
ftpMapping
object[]
​
colorBase
string
​
colorAccent
string
​
colorHover
string
​
colorButton
string
​
colorButtonText
string
​
colorText
string
​
colorFeatured
string
​
colorSold
string
​
colorAvailable
string
​
colorReserved
string
​
styleNavigation
string
​
styleBranding
string
​
styleFilter
string
​
styleShapes
string
​
styleFont
string
​
subscriptionItem
string
​
lastSync
string
​
lockScreen
boolean
default:false
​
specialRankEnabled
boolean
default:false
​
priorityList
boolean
default:false
​
lockScreenName
boolean
default:true
​
lockScreenEmail
boolean
default:true
​
lockScreenPhone
boolean
default:true
​
lockScreenMessage
boolean
default:true
​
lockScreenCustom
boolean
default:false
​
lockScreenCustomQuestions
object[]
​
_3dModelUrl
string
​
reportSendTo
string
​
eventsBlockList
string
​
excludeBlockedEvents
boolean
​
enable3d
boolean
default:false
​
_3dBuildingModelUrl
string
​
_3dFloorSelectorModelUrl
string
​
phasePrefix
string
​
hideGallery
boolean
​
hideBedrooms
boolean
Create ProjectGet Floors