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
}
'import requests
url = "https://app.planpoint.io/api/project/{id}"
payload = {
"_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
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
_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
})
};
fetch('https://app.planpoint.io/api/project/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.planpoint.io/api/project/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'_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
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.planpoint.io/api/project/{id}"
payload := strings.NewReader("{\n \"_id\": \"objectId\",\n \"user\": \"objectId\",\n \"floors\": [\n \"objectId\"\n ],\n \"commercialSpaces\": [\n \"objectId\"\n ],\n \"name\": \"<string>\",\n \"websiteURL\": \"<string>\",\n \"internalURL\": \"<string>\",\n \"accentColor\": \"<string>\",\n \"showInclusions\": true,\n \"showBathrooms\": true,\n \"showAdditionalInfo\": true,\n \"showParking\": true,\n \"showOrientation\": true,\n \"brochureButtonEnabled\": true,\n \"brochureAssets\": [\n \"<string>\"\n ],\n \"customButtonEnabled\": true,\n \"customButtonOpensAt\": \"same_tab\",\n \"walkscoreEnabled\": true,\n \"walkscore\": \"<string>\",\n \"customButtonText\": \"<string>\",\n \"customButtonIcon\": \"<string>\",\n \"showAvailability\": true,\n \"hideSold\": true,\n \"showPrices\": true,\n \"initialView\": \"List\",\n \"gtmEnabled\": false,\n \"dayNightEnabled\": false,\n \"showAvailableFirst\": false,\n \"gtmHeadCode\": \"\",\n \"gtmBodyCode\": \"\",\n \"unitImageOnGrid\": \"Unit Plan\",\n \"skipFloorStep\": false,\n \"areaUnit\": \"<string>\",\n \"showUnitCustomFinishes\": false,\n \"showFloorOverview\": false,\n \"pricesStartingAt\": false,\n \"showPriceFilter\": true,\n \"showAreaFilter\": true,\n \"showUnitDescription\": false,\n \"showTaxes\": true,\n \"sharePageEnabled\": true,\n \"sharePageDescription\": \"<string>\",\n \"sharePageLogo\": \"<string>\",\n \"priceBeforeTax\": true,\n \"enableForms\": true,\n \"rentalObject\": true,\n \"deliveryDates\": true,\n \"hideArea\": false,\n \"showBranding\": true,\n \"projectImageUrl\": \"<string>\",\n \"alternativeCovers\": [\n \"<string>\"\n ],\n \"customButtonActionType\": \"url\",\n \"projectSVGUrl\": \"<string>\",\n \"svgGroupId\": \"<string>\",\n \"layoutImageUrl\": \"<string>\",\n \"formsSendTo\": \"<string>\",\n \"formsSubject\": \"<string>\",\n \"formsFromName\": \"<string>\",\n \"formsMessage\": \"<string>\",\n \"formsRedirectURL\": \"<string>\",\n \"namespace\": \"<string>\",\n \"hostName\": \"<string>\",\n \"projectLang\": \"<string>\",\n \"projectType\": \"<string>\",\n \"propertyType\": \"<string>\",\n \"lotsLayout\": \"<string>\",\n \"areaDescription\": \"<string>\",\n \"enterpriseAddressDisplay\": \"<string>\",\n \"similarSortingBy\": \"default\",\n \"onHoldExperienceEnabled\": false,\n \"onHoldMinsDuration\": 5,\n \"customFormEnabled\": false,\n \"customFormFields\": [],\n \"crfMessage\": \"<string>\",\n \"mapLayoutWidth\": 123,\n \"mapLayoutRotation\": 123,\n \"previewMode\": false,\n \"landOnly\": false,\n \"showUnitFinishes\": false,\n \"showVariants\": false,\n \"administrators\": [\n \"objectId\"\n ],\n \"editors\": [\n \"objectId\"\n ],\n \"globalAmount\": 123,\n \"chargeType\": \"same\",\n \"chargeDescription\": \"\",\n \"chargeCurrency\": \"usd\",\n \"payButtonText\": \"Pay Now\",\n \"payButtonIcon\": \"\",\n \"invites\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"level\": \"<string>\"\n }\n ],\n \"leads\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"unit\": \"<string>\",\n \"message\": \"<string>\",\n \"source\": \"<string>\",\n \"createdAt\": \"<string>\",\n \"questions\": [\n {\n \"question\": \"<string>\",\n \"answer\": \"<string>\"\n }\n ],\n \"customFields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"waitlistees\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"unit\": \"<string>\",\n \"createdAt\": \"<string>\"\n }\n ],\n \"allocations\": [\n {\n \"name\": \"<string>\",\n \"password\": \"<string>\",\n \"allocation\": \"<string>\"\n }\n ],\n \"images\": [\n \"<string>\"\n ],\n \"finishes\": [\n \"<string>\"\n ],\n \"customFinishes\": {\n \"name\": \"<string>\",\n \"options\": {\n \"kitchen\": {\n \"tabs\": [\n {\n \"label\": \"<string>\",\n \"cover\": \"<string>\",\n \"thumbnail\": \"<string>\"\n }\n ]\n },\n \"bathroom\": {\n \"tabs\": [\n {\n \"label\": \"<string>\",\n \"cover\": \"<string>\",\n \"thumbnail\": \"<string>\"\n }\n ]\n },\n \"general\": {\n \"tabs\": [\n {\n \"label\": \"<string>\",\n \"cover\": \"<string>\",\n \"thumbnail\": \"<string>\"\n }\n ]\n }\n }\n },\n \"sponsorsEnabled\": false,\n \"waitlistEnabled\": false,\n \"sponsors\": \"<string>\",\n \"layouts\": \"<string>\",\n \"downloadableAssets\": \"<string>\",\n \"floorplans\": \"<string>\",\n \"plan\": {},\n \"path\": \"<string>\",\n \"alternativePaths\": \"<string>\",\n \"invertNav\": false,\n \"address\": \"<string>\",\n \"lon\": -93.75940812944683,\n \"lat\": 43.75940812944682,\n \"zoomLevel\": 0,\n \"perimeter\": \"<string>\",\n \"markerImageUrl\": \"<string>\",\n \"targetMarker\": \"<string>\",\n \"mapStyle\": \"Light\",\n \"mapPointColor\": \"<string>\",\n \"mapDirections\": false,\n \"calUsername\": \"<string>\",\n \"calKey\": \"<string>\",\n \"payPalClientId\": \"<string>\",\n \"payPalDeposit\": 123,\n \"payPalCurrency\": \"<string>\",\n \"yiApiToken\": \"<string>\",\n \"yiCompanyCode\": \"<string>\",\n \"yiPropertyCode\": \"<string>\",\n \"yiStatusMapping\": {\n \"available\": \"<string>\",\n \"leased\": \"<string>\",\n \"sold\": \"<string>\",\n \"unavailable\": \"<string>\",\n \"reserved\": \"<string>\"\n },\n \"pvUsername\": \"<string>\",\n \"pvPassword\": \"<string>\",\n \"pvBuildingName\": \"<string>\",\n \"zhClientId\": \"<string>\",\n \"zhAccessToken\": \"<string>\",\n \"zhClientSecret\": \"<string>\",\n \"zhOrgId\": \"<string>\",\n \"srToken\": \"<string>\",\n \"srBaseUrl\": \"<string>\",\n \"sfProjectId\": \"<string>\",\n \"sfKey\": \"<string>\",\n \"sfSecret\": \"<string>\",\n \"soProjectId\": \"<string>\",\n \"soKey\": \"<string>\",\n \"soSecret\": \"<string>\",\n \"soDomain\": \"<string>\",\n \"bsBuildingId\": \"<string>\",\n \"bsUsername\": \"<string>\",\n \"bsPassword\": \"<string>\",\n \"ftpUrl\": \"<string>\",\n \"ftpPort\": 123,\n \"ftpUsername\": \"<string>\",\n \"ftpPassword\": \"<string>\",\n \"ftpWhitelist\": \"<string>\",\n \"ftpBlacklist\": \"<string>\",\n \"ftpPath\": \"<string>\",\n \"ftpFileName\": \"<string>\",\n \"ftpMapping\": [\n {\n \"header\": \"<string>\",\n \"property\": \"<string>\"\n }\n ],\n \"colorBase\": \"<string>\",\n \"colorAccent\": \"<string>\",\n \"colorHover\": \"<string>\",\n \"colorButton\": \"<string>\",\n \"colorButtonText\": \"<string>\",\n \"colorText\": \"<string>\",\n \"colorFeatured\": \"<string>\",\n \"colorSold\": \"<string>\",\n \"colorAvailable\": \"<string>\",\n \"colorReserved\": \"<string>\",\n \"styleNavigation\": \"<string>\",\n \"styleBranding\": \"<string>\",\n \"styleFilter\": \"<string>\",\n \"styleShapes\": \"<string>\",\n \"styleFont\": \"<string>\",\n \"subscriptionItem\": \"<string>\",\n \"lastSync\": \"<string>\",\n \"lockScreen\": false,\n \"specialRankEnabled\": false,\n \"priorityList\": false,\n \"lockScreenName\": true,\n \"lockScreenEmail\": true,\n \"lockScreenPhone\": true,\n \"lockScreenMessage\": true,\n \"lockScreenCustom\": false,\n \"lockScreenCustomQuestions\": [\n {\n \"lang\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"_3dModelUrl\": \"<string>\",\n \"reportSendTo\": \"<string>\",\n \"eventsBlockList\": \"<string>\",\n \"excludeBlockedEvents\": true,\n \"enable3d\": false,\n \"_3dBuildingModelUrl\": \"<string>\",\n \"_3dFloorSelectorModelUrl\": \"<string>\",\n \"phasePrefix\": \"<string>\",\n \"hideGallery\": true,\n \"hideBedrooms\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://app.planpoint.io/api/project/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"_id\": \"objectId\",\n \"user\": \"objectId\",\n \"floors\": [\n \"objectId\"\n ],\n \"commercialSpaces\": [\n \"objectId\"\n ],\n \"name\": \"<string>\",\n \"websiteURL\": \"<string>\",\n \"internalURL\": \"<string>\",\n \"accentColor\": \"<string>\",\n \"showInclusions\": true,\n \"showBathrooms\": true,\n \"showAdditionalInfo\": true,\n \"showParking\": true,\n \"showOrientation\": true,\n \"brochureButtonEnabled\": true,\n \"brochureAssets\": [\n \"<string>\"\n ],\n \"customButtonEnabled\": true,\n \"customButtonOpensAt\": \"same_tab\",\n \"walkscoreEnabled\": true,\n \"walkscore\": \"<string>\",\n \"customButtonText\": \"<string>\",\n \"customButtonIcon\": \"<string>\",\n \"showAvailability\": true,\n \"hideSold\": true,\n \"showPrices\": true,\n \"initialView\": \"List\",\n \"gtmEnabled\": false,\n \"dayNightEnabled\": false,\n \"showAvailableFirst\": false,\n \"gtmHeadCode\": \"\",\n \"gtmBodyCode\": \"\",\n \"unitImageOnGrid\": \"Unit Plan\",\n \"skipFloorStep\": false,\n \"areaUnit\": \"<string>\",\n \"showUnitCustomFinishes\": false,\n \"showFloorOverview\": false,\n \"pricesStartingAt\": false,\n \"showPriceFilter\": true,\n \"showAreaFilter\": true,\n \"showUnitDescription\": false,\n \"showTaxes\": true,\n \"sharePageEnabled\": true,\n \"sharePageDescription\": \"<string>\",\n \"sharePageLogo\": \"<string>\",\n \"priceBeforeTax\": true,\n \"enableForms\": true,\n \"rentalObject\": true,\n \"deliveryDates\": true,\n \"hideArea\": false,\n \"showBranding\": true,\n \"projectImageUrl\": \"<string>\",\n \"alternativeCovers\": [\n \"<string>\"\n ],\n \"customButtonActionType\": \"url\",\n \"projectSVGUrl\": \"<string>\",\n \"svgGroupId\": \"<string>\",\n \"layoutImageUrl\": \"<string>\",\n \"formsSendTo\": \"<string>\",\n \"formsSubject\": \"<string>\",\n \"formsFromName\": \"<string>\",\n \"formsMessage\": \"<string>\",\n \"formsRedirectURL\": \"<string>\",\n \"namespace\": \"<string>\",\n \"hostName\": \"<string>\",\n \"projectLang\": \"<string>\",\n \"projectType\": \"<string>\",\n \"propertyType\": \"<string>\",\n \"lotsLayout\": \"<string>\",\n \"areaDescription\": \"<string>\",\n \"enterpriseAddressDisplay\": \"<string>\",\n \"similarSortingBy\": \"default\",\n \"onHoldExperienceEnabled\": false,\n \"onHoldMinsDuration\": 5,\n \"customFormEnabled\": false,\n \"customFormFields\": [],\n \"crfMessage\": \"<string>\",\n \"mapLayoutWidth\": 123,\n \"mapLayoutRotation\": 123,\n \"previewMode\": false,\n \"landOnly\": false,\n \"showUnitFinishes\": false,\n \"showVariants\": false,\n \"administrators\": [\n \"objectId\"\n ],\n \"editors\": [\n \"objectId\"\n ],\n \"globalAmount\": 123,\n \"chargeType\": \"same\",\n \"chargeDescription\": \"\",\n \"chargeCurrency\": \"usd\",\n \"payButtonText\": \"Pay Now\",\n \"payButtonIcon\": \"\",\n \"invites\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"level\": \"<string>\"\n }\n ],\n \"leads\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"unit\": \"<string>\",\n \"message\": \"<string>\",\n \"source\": \"<string>\",\n \"createdAt\": \"<string>\",\n \"questions\": [\n {\n \"question\": \"<string>\",\n \"answer\": \"<string>\"\n }\n ],\n \"customFields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"waitlistees\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"unit\": \"<string>\",\n \"createdAt\": \"<string>\"\n }\n ],\n \"allocations\": [\n {\n \"name\": \"<string>\",\n \"password\": \"<string>\",\n \"allocation\": \"<string>\"\n }\n ],\n \"images\": [\n \"<string>\"\n ],\n \"finishes\": [\n \"<string>\"\n ],\n \"customFinishes\": {\n \"name\": \"<string>\",\n \"options\": {\n \"kitchen\": {\n \"tabs\": [\n {\n \"label\": \"<string>\",\n \"cover\": \"<string>\",\n \"thumbnail\": \"<string>\"\n }\n ]\n },\n \"bathroom\": {\n \"tabs\": [\n {\n \"label\": \"<string>\",\n \"cover\": \"<string>\",\n \"thumbnail\": \"<string>\"\n }\n ]\n },\n \"general\": {\n \"tabs\": [\n {\n \"label\": \"<string>\",\n \"cover\": \"<string>\",\n \"thumbnail\": \"<string>\"\n }\n ]\n }\n }\n },\n \"sponsorsEnabled\": false,\n \"waitlistEnabled\": false,\n \"sponsors\": \"<string>\",\n \"layouts\": \"<string>\",\n \"downloadableAssets\": \"<string>\",\n \"floorplans\": \"<string>\",\n \"plan\": {},\n \"path\": \"<string>\",\n \"alternativePaths\": \"<string>\",\n \"invertNav\": false,\n \"address\": \"<string>\",\n \"lon\": -93.75940812944683,\n \"lat\": 43.75940812944682,\n \"zoomLevel\": 0,\n \"perimeter\": \"<string>\",\n \"markerImageUrl\": \"<string>\",\n \"targetMarker\": \"<string>\",\n \"mapStyle\": \"Light\",\n \"mapPointColor\": \"<string>\",\n \"mapDirections\": false,\n \"calUsername\": \"<string>\",\n \"calKey\": \"<string>\",\n \"payPalClientId\": \"<string>\",\n \"payPalDeposit\": 123,\n \"payPalCurrency\": \"<string>\",\n \"yiApiToken\": \"<string>\",\n \"yiCompanyCode\": \"<string>\",\n \"yiPropertyCode\": \"<string>\",\n \"yiStatusMapping\": {\n \"available\": \"<string>\",\n \"leased\": \"<string>\",\n \"sold\": \"<string>\",\n \"unavailable\": \"<string>\",\n \"reserved\": \"<string>\"\n },\n \"pvUsername\": \"<string>\",\n \"pvPassword\": \"<string>\",\n \"pvBuildingName\": \"<string>\",\n \"zhClientId\": \"<string>\",\n \"zhAccessToken\": \"<string>\",\n \"zhClientSecret\": \"<string>\",\n \"zhOrgId\": \"<string>\",\n \"srToken\": \"<string>\",\n \"srBaseUrl\": \"<string>\",\n \"sfProjectId\": \"<string>\",\n \"sfKey\": \"<string>\",\n \"sfSecret\": \"<string>\",\n \"soProjectId\": \"<string>\",\n \"soKey\": \"<string>\",\n \"soSecret\": \"<string>\",\n \"soDomain\": \"<string>\",\n \"bsBuildingId\": \"<string>\",\n \"bsUsername\": \"<string>\",\n \"bsPassword\": \"<string>\",\n \"ftpUrl\": \"<string>\",\n \"ftpPort\": 123,\n \"ftpUsername\": \"<string>\",\n \"ftpPassword\": \"<string>\",\n \"ftpWhitelist\": \"<string>\",\n \"ftpBlacklist\": \"<string>\",\n \"ftpPath\": \"<string>\",\n \"ftpFileName\": \"<string>\",\n \"ftpMapping\": [\n {\n \"header\": \"<string>\",\n \"property\": \"<string>\"\n }\n ],\n \"colorBase\": \"<string>\",\n \"colorAccent\": \"<string>\",\n \"colorHover\": \"<string>\",\n \"colorButton\": \"<string>\",\n \"colorButtonText\": \"<string>\",\n \"colorText\": \"<string>\",\n \"colorFeatured\": \"<string>\",\n \"colorSold\": \"<string>\",\n \"colorAvailable\": \"<string>\",\n \"colorReserved\": \"<string>\",\n \"styleNavigation\": \"<string>\",\n \"styleBranding\": \"<string>\",\n \"styleFilter\": \"<string>\",\n \"styleShapes\": \"<string>\",\n \"styleFont\": \"<string>\",\n \"subscriptionItem\": \"<string>\",\n \"lastSync\": \"<string>\",\n \"lockScreen\": false,\n \"specialRankEnabled\": false,\n \"priorityList\": false,\n \"lockScreenName\": true,\n \"lockScreenEmail\": true,\n \"lockScreenPhone\": true,\n \"lockScreenMessage\": true,\n \"lockScreenCustom\": false,\n \"lockScreenCustomQuestions\": [\n {\n \"lang\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"_3dModelUrl\": \"<string>\",\n \"reportSendTo\": \"<string>\",\n \"eventsBlockList\": \"<string>\",\n \"excludeBlockedEvents\": true,\n \"enable3d\": false,\n \"_3dBuildingModelUrl\": \"<string>\",\n \"_3dFloorSelectorModelUrl\": \"<string>\",\n \"phasePrefix\": \"<string>\",\n \"hideGallery\": true,\n \"hideBedrooms\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.planpoint.io/api/project/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"_id\": \"objectId\",\n \"user\": \"objectId\",\n \"floors\": [\n \"objectId\"\n ],\n \"commercialSpaces\": [\n \"objectId\"\n ],\n \"name\": \"<string>\",\n \"websiteURL\": \"<string>\",\n \"internalURL\": \"<string>\",\n \"accentColor\": \"<string>\",\n \"showInclusions\": true,\n \"showBathrooms\": true,\n \"showAdditionalInfo\": true,\n \"showParking\": true,\n \"showOrientation\": true,\n \"brochureButtonEnabled\": true,\n \"brochureAssets\": [\n \"<string>\"\n ],\n \"customButtonEnabled\": true,\n \"customButtonOpensAt\": \"same_tab\",\n \"walkscoreEnabled\": true,\n \"walkscore\": \"<string>\",\n \"customButtonText\": \"<string>\",\n \"customButtonIcon\": \"<string>\",\n \"showAvailability\": true,\n \"hideSold\": true,\n \"showPrices\": true,\n \"initialView\": \"List\",\n \"gtmEnabled\": false,\n \"dayNightEnabled\": false,\n \"showAvailableFirst\": false,\n \"gtmHeadCode\": \"\",\n \"gtmBodyCode\": \"\",\n \"unitImageOnGrid\": \"Unit Plan\",\n \"skipFloorStep\": false,\n \"areaUnit\": \"<string>\",\n \"showUnitCustomFinishes\": false,\n \"showFloorOverview\": false,\n \"pricesStartingAt\": false,\n \"showPriceFilter\": true,\n \"showAreaFilter\": true,\n \"showUnitDescription\": false,\n \"showTaxes\": true,\n \"sharePageEnabled\": true,\n \"sharePageDescription\": \"<string>\",\n \"sharePageLogo\": \"<string>\",\n \"priceBeforeTax\": true,\n \"enableForms\": true,\n \"rentalObject\": true,\n \"deliveryDates\": true,\n \"hideArea\": false,\n \"showBranding\": true,\n \"projectImageUrl\": \"<string>\",\n \"alternativeCovers\": [\n \"<string>\"\n ],\n \"customButtonActionType\": \"url\",\n \"projectSVGUrl\": \"<string>\",\n \"svgGroupId\": \"<string>\",\n \"layoutImageUrl\": \"<string>\",\n \"formsSendTo\": \"<string>\",\n \"formsSubject\": \"<string>\",\n \"formsFromName\": \"<string>\",\n \"formsMessage\": \"<string>\",\n \"formsRedirectURL\": \"<string>\",\n \"namespace\": \"<string>\",\n \"hostName\": \"<string>\",\n \"projectLang\": \"<string>\",\n \"projectType\": \"<string>\",\n \"propertyType\": \"<string>\",\n \"lotsLayout\": \"<string>\",\n \"areaDescription\": \"<string>\",\n \"enterpriseAddressDisplay\": \"<string>\",\n \"similarSortingBy\": \"default\",\n \"onHoldExperienceEnabled\": false,\n \"onHoldMinsDuration\": 5,\n \"customFormEnabled\": false,\n \"customFormFields\": [],\n \"crfMessage\": \"<string>\",\n \"mapLayoutWidth\": 123,\n \"mapLayoutRotation\": 123,\n \"previewMode\": false,\n \"landOnly\": false,\n \"showUnitFinishes\": false,\n \"showVariants\": false,\n \"administrators\": [\n \"objectId\"\n ],\n \"editors\": [\n \"objectId\"\n ],\n \"globalAmount\": 123,\n \"chargeType\": \"same\",\n \"chargeDescription\": \"\",\n \"chargeCurrency\": \"usd\",\n \"payButtonText\": \"Pay Now\",\n \"payButtonIcon\": \"\",\n \"invites\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"level\": \"<string>\"\n }\n ],\n \"leads\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"unit\": \"<string>\",\n \"message\": \"<string>\",\n \"source\": \"<string>\",\n \"createdAt\": \"<string>\",\n \"questions\": [\n {\n \"question\": \"<string>\",\n \"answer\": \"<string>\"\n }\n ],\n \"customFields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"waitlistees\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"unit\": \"<string>\",\n \"createdAt\": \"<string>\"\n }\n ],\n \"allocations\": [\n {\n \"name\": \"<string>\",\n \"password\": \"<string>\",\n \"allocation\": \"<string>\"\n }\n ],\n \"images\": [\n \"<string>\"\n ],\n \"finishes\": [\n \"<string>\"\n ],\n \"customFinishes\": {\n \"name\": \"<string>\",\n \"options\": {\n \"kitchen\": {\n \"tabs\": [\n {\n \"label\": \"<string>\",\n \"cover\": \"<string>\",\n \"thumbnail\": \"<string>\"\n }\n ]\n },\n \"bathroom\": {\n \"tabs\": [\n {\n \"label\": \"<string>\",\n \"cover\": \"<string>\",\n \"thumbnail\": \"<string>\"\n }\n ]\n },\n \"general\": {\n \"tabs\": [\n {\n \"label\": \"<string>\",\n \"cover\": \"<string>\",\n \"thumbnail\": \"<string>\"\n }\n ]\n }\n }\n },\n \"sponsorsEnabled\": false,\n \"waitlistEnabled\": false,\n \"sponsors\": \"<string>\",\n \"layouts\": \"<string>\",\n \"downloadableAssets\": \"<string>\",\n \"floorplans\": \"<string>\",\n \"plan\": {},\n \"path\": \"<string>\",\n \"alternativePaths\": \"<string>\",\n \"invertNav\": false,\n \"address\": \"<string>\",\n \"lon\": -93.75940812944683,\n \"lat\": 43.75940812944682,\n \"zoomLevel\": 0,\n \"perimeter\": \"<string>\",\n \"markerImageUrl\": \"<string>\",\n \"targetMarker\": \"<string>\",\n \"mapStyle\": \"Light\",\n \"mapPointColor\": \"<string>\",\n \"mapDirections\": false,\n \"calUsername\": \"<string>\",\n \"calKey\": \"<string>\",\n \"payPalClientId\": \"<string>\",\n \"payPalDeposit\": 123,\n \"payPalCurrency\": \"<string>\",\n \"yiApiToken\": \"<string>\",\n \"yiCompanyCode\": \"<string>\",\n \"yiPropertyCode\": \"<string>\",\n \"yiStatusMapping\": {\n \"available\": \"<string>\",\n \"leased\": \"<string>\",\n \"sold\": \"<string>\",\n \"unavailable\": \"<string>\",\n \"reserved\": \"<string>\"\n },\n \"pvUsername\": \"<string>\",\n \"pvPassword\": \"<string>\",\n \"pvBuildingName\": \"<string>\",\n \"zhClientId\": \"<string>\",\n \"zhAccessToken\": \"<string>\",\n \"zhClientSecret\": \"<string>\",\n \"zhOrgId\": \"<string>\",\n \"srToken\": \"<string>\",\n \"srBaseUrl\": \"<string>\",\n \"sfProjectId\": \"<string>\",\n \"sfKey\": \"<string>\",\n \"sfSecret\": \"<string>\",\n \"soProjectId\": \"<string>\",\n \"soKey\": \"<string>\",\n \"soSecret\": \"<string>\",\n \"soDomain\": \"<string>\",\n \"bsBuildingId\": \"<string>\",\n \"bsUsername\": \"<string>\",\n \"bsPassword\": \"<string>\",\n \"ftpUrl\": \"<string>\",\n \"ftpPort\": 123,\n \"ftpUsername\": \"<string>\",\n \"ftpPassword\": \"<string>\",\n \"ftpWhitelist\": \"<string>\",\n \"ftpBlacklist\": \"<string>\",\n \"ftpPath\": \"<string>\",\n \"ftpFileName\": \"<string>\",\n \"ftpMapping\": [\n {\n \"header\": \"<string>\",\n \"property\": \"<string>\"\n }\n ],\n \"colorBase\": \"<string>\",\n \"colorAccent\": \"<string>\",\n \"colorHover\": \"<string>\",\n \"colorButton\": \"<string>\",\n \"colorButtonText\": \"<string>\",\n \"colorText\": \"<string>\",\n \"colorFeatured\": \"<string>\",\n \"colorSold\": \"<string>\",\n \"colorAvailable\": \"<string>\",\n \"colorReserved\": \"<string>\",\n \"styleNavigation\": \"<string>\",\n \"styleBranding\": \"<string>\",\n \"styleFilter\": \"<string>\",\n \"styleShapes\": \"<string>\",\n \"styleFont\": \"<string>\",\n \"subscriptionItem\": \"<string>\",\n \"lastSync\": \"<string>\",\n \"lockScreen\": false,\n \"specialRankEnabled\": false,\n \"priorityList\": false,\n \"lockScreenName\": true,\n \"lockScreenEmail\": true,\n \"lockScreenPhone\": true,\n \"lockScreenMessage\": true,\n \"lockScreenCustom\": false,\n \"lockScreenCustomQuestions\": [\n {\n \"lang\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"_3dModelUrl\": \"<string>\",\n \"reportSendTo\": \"<string>\",\n \"eventsBlockList\": \"<string>\",\n \"excludeBlockedEvents\": true,\n \"enable3d\": false,\n \"_3dBuildingModelUrl\": \"<string>\",\n \"_3dFloorSelectorModelUrl\": \"<string>\",\n \"phasePrefix\": \"<string>\",\n \"hideGallery\": true,\n \"hideBedrooms\": true\n}"
response = http.request(request)
puts response.read_body{
"_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
}Update Project
Update an existing project by 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
}
'import requests
url = "https://app.planpoint.io/api/project/{id}"
payload = {
"_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
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
_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
})
};
fetch('https://app.planpoint.io/api/project/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.planpoint.io/api/project/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'_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
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.planpoint.io/api/project/{id}"
payload := strings.NewReader("{\n \"_id\": \"objectId\",\n \"user\": \"objectId\",\n \"floors\": [\n \"objectId\"\n ],\n \"commercialSpaces\": [\n \"objectId\"\n ],\n \"name\": \"<string>\",\n \"websiteURL\": \"<string>\",\n \"internalURL\": \"<string>\",\n \"accentColor\": \"<string>\",\n \"showInclusions\": true,\n \"showBathrooms\": true,\n \"showAdditionalInfo\": true,\n \"showParking\": true,\n \"showOrientation\": true,\n \"brochureButtonEnabled\": true,\n \"brochureAssets\": [\n \"<string>\"\n ],\n \"customButtonEnabled\": true,\n \"customButtonOpensAt\": \"same_tab\",\n \"walkscoreEnabled\": true,\n \"walkscore\": \"<string>\",\n \"customButtonText\": \"<string>\",\n \"customButtonIcon\": \"<string>\",\n \"showAvailability\": true,\n \"hideSold\": true,\n \"showPrices\": true,\n \"initialView\": \"List\",\n \"gtmEnabled\": false,\n \"dayNightEnabled\": false,\n \"showAvailableFirst\": false,\n \"gtmHeadCode\": \"\",\n \"gtmBodyCode\": \"\",\n \"unitImageOnGrid\": \"Unit Plan\",\n \"skipFloorStep\": false,\n \"areaUnit\": \"<string>\",\n \"showUnitCustomFinishes\": false,\n \"showFloorOverview\": false,\n \"pricesStartingAt\": false,\n \"showPriceFilter\": true,\n \"showAreaFilter\": true,\n \"showUnitDescription\": false,\n \"showTaxes\": true,\n \"sharePageEnabled\": true,\n \"sharePageDescription\": \"<string>\",\n \"sharePageLogo\": \"<string>\",\n \"priceBeforeTax\": true,\n \"enableForms\": true,\n \"rentalObject\": true,\n \"deliveryDates\": true,\n \"hideArea\": false,\n \"showBranding\": true,\n \"projectImageUrl\": \"<string>\",\n \"alternativeCovers\": [\n \"<string>\"\n ],\n \"customButtonActionType\": \"url\",\n \"projectSVGUrl\": \"<string>\",\n \"svgGroupId\": \"<string>\",\n \"layoutImageUrl\": \"<string>\",\n \"formsSendTo\": \"<string>\",\n \"formsSubject\": \"<string>\",\n \"formsFromName\": \"<string>\",\n \"formsMessage\": \"<string>\",\n \"formsRedirectURL\": \"<string>\",\n \"namespace\": \"<string>\",\n \"hostName\": \"<string>\",\n \"projectLang\": \"<string>\",\n \"projectType\": \"<string>\",\n \"propertyType\": \"<string>\",\n \"lotsLayout\": \"<string>\",\n \"areaDescription\": \"<string>\",\n \"enterpriseAddressDisplay\": \"<string>\",\n \"similarSortingBy\": \"default\",\n \"onHoldExperienceEnabled\": false,\n \"onHoldMinsDuration\": 5,\n \"customFormEnabled\": false,\n \"customFormFields\": [],\n \"crfMessage\": \"<string>\",\n \"mapLayoutWidth\": 123,\n \"mapLayoutRotation\": 123,\n \"previewMode\": false,\n \"landOnly\": false,\n \"showUnitFinishes\": false,\n \"showVariants\": false,\n \"administrators\": [\n \"objectId\"\n ],\n \"editors\": [\n \"objectId\"\n ],\n \"globalAmount\": 123,\n \"chargeType\": \"same\",\n \"chargeDescription\": \"\",\n \"chargeCurrency\": \"usd\",\n \"payButtonText\": \"Pay Now\",\n \"payButtonIcon\": \"\",\n \"invites\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"level\": \"<string>\"\n }\n ],\n \"leads\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"unit\": \"<string>\",\n \"message\": \"<string>\",\n \"source\": \"<string>\",\n \"createdAt\": \"<string>\",\n \"questions\": [\n {\n \"question\": \"<string>\",\n \"answer\": \"<string>\"\n }\n ],\n \"customFields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"waitlistees\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"unit\": \"<string>\",\n \"createdAt\": \"<string>\"\n }\n ],\n \"allocations\": [\n {\n \"name\": \"<string>\",\n \"password\": \"<string>\",\n \"allocation\": \"<string>\"\n }\n ],\n \"images\": [\n \"<string>\"\n ],\n \"finishes\": [\n \"<string>\"\n ],\n \"customFinishes\": {\n \"name\": \"<string>\",\n \"options\": {\n \"kitchen\": {\n \"tabs\": [\n {\n \"label\": \"<string>\",\n \"cover\": \"<string>\",\n \"thumbnail\": \"<string>\"\n }\n ]\n },\n \"bathroom\": {\n \"tabs\": [\n {\n \"label\": \"<string>\",\n \"cover\": \"<string>\",\n \"thumbnail\": \"<string>\"\n }\n ]\n },\n \"general\": {\n \"tabs\": [\n {\n \"label\": \"<string>\",\n \"cover\": \"<string>\",\n \"thumbnail\": \"<string>\"\n }\n ]\n }\n }\n },\n \"sponsorsEnabled\": false,\n \"waitlistEnabled\": false,\n \"sponsors\": \"<string>\",\n \"layouts\": \"<string>\",\n \"downloadableAssets\": \"<string>\",\n \"floorplans\": \"<string>\",\n \"plan\": {},\n \"path\": \"<string>\",\n \"alternativePaths\": \"<string>\",\n \"invertNav\": false,\n \"address\": \"<string>\",\n \"lon\": -93.75940812944683,\n \"lat\": 43.75940812944682,\n \"zoomLevel\": 0,\n \"perimeter\": \"<string>\",\n \"markerImageUrl\": \"<string>\",\n \"targetMarker\": \"<string>\",\n \"mapStyle\": \"Light\",\n \"mapPointColor\": \"<string>\",\n \"mapDirections\": false,\n \"calUsername\": \"<string>\",\n \"calKey\": \"<string>\",\n \"payPalClientId\": \"<string>\",\n \"payPalDeposit\": 123,\n \"payPalCurrency\": \"<string>\",\n \"yiApiToken\": \"<string>\",\n \"yiCompanyCode\": \"<string>\",\n \"yiPropertyCode\": \"<string>\",\n \"yiStatusMapping\": {\n \"available\": \"<string>\",\n \"leased\": \"<string>\",\n \"sold\": \"<string>\",\n \"unavailable\": \"<string>\",\n \"reserved\": \"<string>\"\n },\n \"pvUsername\": \"<string>\",\n \"pvPassword\": \"<string>\",\n \"pvBuildingName\": \"<string>\",\n \"zhClientId\": \"<string>\",\n \"zhAccessToken\": \"<string>\",\n \"zhClientSecret\": \"<string>\",\n \"zhOrgId\": \"<string>\",\n \"srToken\": \"<string>\",\n \"srBaseUrl\": \"<string>\",\n \"sfProjectId\": \"<string>\",\n \"sfKey\": \"<string>\",\n \"sfSecret\": \"<string>\",\n \"soProjectId\": \"<string>\",\n \"soKey\": \"<string>\",\n \"soSecret\": \"<string>\",\n \"soDomain\": \"<string>\",\n \"bsBuildingId\": \"<string>\",\n \"bsUsername\": \"<string>\",\n \"bsPassword\": \"<string>\",\n \"ftpUrl\": \"<string>\",\n \"ftpPort\": 123,\n \"ftpUsername\": \"<string>\",\n \"ftpPassword\": \"<string>\",\n \"ftpWhitelist\": \"<string>\",\n \"ftpBlacklist\": \"<string>\",\n \"ftpPath\": \"<string>\",\n \"ftpFileName\": \"<string>\",\n \"ftpMapping\": [\n {\n \"header\": \"<string>\",\n \"property\": \"<string>\"\n }\n ],\n \"colorBase\": \"<string>\",\n \"colorAccent\": \"<string>\",\n \"colorHover\": \"<string>\",\n \"colorButton\": \"<string>\",\n \"colorButtonText\": \"<string>\",\n \"colorText\": \"<string>\",\n \"colorFeatured\": \"<string>\",\n \"colorSold\": \"<string>\",\n \"colorAvailable\": \"<string>\",\n \"colorReserved\": \"<string>\",\n \"styleNavigation\": \"<string>\",\n \"styleBranding\": \"<string>\",\n \"styleFilter\": \"<string>\",\n \"styleShapes\": \"<string>\",\n \"styleFont\": \"<string>\",\n \"subscriptionItem\": \"<string>\",\n \"lastSync\": \"<string>\",\n \"lockScreen\": false,\n \"specialRankEnabled\": false,\n \"priorityList\": false,\n \"lockScreenName\": true,\n \"lockScreenEmail\": true,\n \"lockScreenPhone\": true,\n \"lockScreenMessage\": true,\n \"lockScreenCustom\": false,\n \"lockScreenCustomQuestions\": [\n {\n \"lang\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"_3dModelUrl\": \"<string>\",\n \"reportSendTo\": \"<string>\",\n \"eventsBlockList\": \"<string>\",\n \"excludeBlockedEvents\": true,\n \"enable3d\": false,\n \"_3dBuildingModelUrl\": \"<string>\",\n \"_3dFloorSelectorModelUrl\": \"<string>\",\n \"phasePrefix\": \"<string>\",\n \"hideGallery\": true,\n \"hideBedrooms\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://app.planpoint.io/api/project/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"_id\": \"objectId\",\n \"user\": \"objectId\",\n \"floors\": [\n \"objectId\"\n ],\n \"commercialSpaces\": [\n \"objectId\"\n ],\n \"name\": \"<string>\",\n \"websiteURL\": \"<string>\",\n \"internalURL\": \"<string>\",\n \"accentColor\": \"<string>\",\n \"showInclusions\": true,\n \"showBathrooms\": true,\n \"showAdditionalInfo\": true,\n \"showParking\": true,\n \"showOrientation\": true,\n \"brochureButtonEnabled\": true,\n \"brochureAssets\": [\n \"<string>\"\n ],\n \"customButtonEnabled\": true,\n \"customButtonOpensAt\": \"same_tab\",\n \"walkscoreEnabled\": true,\n \"walkscore\": \"<string>\",\n \"customButtonText\": \"<string>\",\n \"customButtonIcon\": \"<string>\",\n \"showAvailability\": true,\n \"hideSold\": true,\n \"showPrices\": true,\n \"initialView\": \"List\",\n \"gtmEnabled\": false,\n \"dayNightEnabled\": false,\n \"showAvailableFirst\": false,\n \"gtmHeadCode\": \"\",\n \"gtmBodyCode\": \"\",\n \"unitImageOnGrid\": \"Unit Plan\",\n \"skipFloorStep\": false,\n \"areaUnit\": \"<string>\",\n \"showUnitCustomFinishes\": false,\n \"showFloorOverview\": false,\n \"pricesStartingAt\": false,\n \"showPriceFilter\": true,\n \"showAreaFilter\": true,\n \"showUnitDescription\": false,\n \"showTaxes\": true,\n \"sharePageEnabled\": true,\n \"sharePageDescription\": \"<string>\",\n \"sharePageLogo\": \"<string>\",\n \"priceBeforeTax\": true,\n \"enableForms\": true,\n \"rentalObject\": true,\n \"deliveryDates\": true,\n \"hideArea\": false,\n \"showBranding\": true,\n \"projectImageUrl\": \"<string>\",\n \"alternativeCovers\": [\n \"<string>\"\n ],\n \"customButtonActionType\": \"url\",\n \"projectSVGUrl\": \"<string>\",\n \"svgGroupId\": \"<string>\",\n \"layoutImageUrl\": \"<string>\",\n \"formsSendTo\": \"<string>\",\n \"formsSubject\": \"<string>\",\n \"formsFromName\": \"<string>\",\n \"formsMessage\": \"<string>\",\n \"formsRedirectURL\": \"<string>\",\n \"namespace\": \"<string>\",\n \"hostName\": \"<string>\",\n \"projectLang\": \"<string>\",\n \"projectType\": \"<string>\",\n \"propertyType\": \"<string>\",\n \"lotsLayout\": \"<string>\",\n \"areaDescription\": \"<string>\",\n \"enterpriseAddressDisplay\": \"<string>\",\n \"similarSortingBy\": \"default\",\n \"onHoldExperienceEnabled\": false,\n \"onHoldMinsDuration\": 5,\n \"customFormEnabled\": false,\n \"customFormFields\": [],\n \"crfMessage\": \"<string>\",\n \"mapLayoutWidth\": 123,\n \"mapLayoutRotation\": 123,\n \"previewMode\": false,\n \"landOnly\": false,\n \"showUnitFinishes\": false,\n \"showVariants\": false,\n \"administrators\": [\n \"objectId\"\n ],\n \"editors\": [\n \"objectId\"\n ],\n \"globalAmount\": 123,\n \"chargeType\": \"same\",\n \"chargeDescription\": \"\",\n \"chargeCurrency\": \"usd\",\n \"payButtonText\": \"Pay Now\",\n \"payButtonIcon\": \"\",\n \"invites\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"level\": \"<string>\"\n }\n ],\n \"leads\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"unit\": \"<string>\",\n \"message\": \"<string>\",\n \"source\": \"<string>\",\n \"createdAt\": \"<string>\",\n \"questions\": [\n {\n \"question\": \"<string>\",\n \"answer\": \"<string>\"\n }\n ],\n \"customFields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"waitlistees\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"unit\": \"<string>\",\n \"createdAt\": \"<string>\"\n }\n ],\n \"allocations\": [\n {\n \"name\": \"<string>\",\n \"password\": \"<string>\",\n \"allocation\": \"<string>\"\n }\n ],\n \"images\": [\n \"<string>\"\n ],\n \"finishes\": [\n \"<string>\"\n ],\n \"customFinishes\": {\n \"name\": \"<string>\",\n \"options\": {\n \"kitchen\": {\n \"tabs\": [\n {\n \"label\": \"<string>\",\n \"cover\": \"<string>\",\n \"thumbnail\": \"<string>\"\n }\n ]\n },\n \"bathroom\": {\n \"tabs\": [\n {\n \"label\": \"<string>\",\n \"cover\": \"<string>\",\n \"thumbnail\": \"<string>\"\n }\n ]\n },\n \"general\": {\n \"tabs\": [\n {\n \"label\": \"<string>\",\n \"cover\": \"<string>\",\n \"thumbnail\": \"<string>\"\n }\n ]\n }\n }\n },\n \"sponsorsEnabled\": false,\n \"waitlistEnabled\": false,\n \"sponsors\": \"<string>\",\n \"layouts\": \"<string>\",\n \"downloadableAssets\": \"<string>\",\n \"floorplans\": \"<string>\",\n \"plan\": {},\n \"path\": \"<string>\",\n \"alternativePaths\": \"<string>\",\n \"invertNav\": false,\n \"address\": \"<string>\",\n \"lon\": -93.75940812944683,\n \"lat\": 43.75940812944682,\n \"zoomLevel\": 0,\n \"perimeter\": \"<string>\",\n \"markerImageUrl\": \"<string>\",\n \"targetMarker\": \"<string>\",\n \"mapStyle\": \"Light\",\n \"mapPointColor\": \"<string>\",\n \"mapDirections\": false,\n \"calUsername\": \"<string>\",\n \"calKey\": \"<string>\",\n \"payPalClientId\": \"<string>\",\n \"payPalDeposit\": 123,\n \"payPalCurrency\": \"<string>\",\n \"yiApiToken\": \"<string>\",\n \"yiCompanyCode\": \"<string>\",\n \"yiPropertyCode\": \"<string>\",\n \"yiStatusMapping\": {\n \"available\": \"<string>\",\n \"leased\": \"<string>\",\n \"sold\": \"<string>\",\n \"unavailable\": \"<string>\",\n \"reserved\": \"<string>\"\n },\n \"pvUsername\": \"<string>\",\n \"pvPassword\": \"<string>\",\n \"pvBuildingName\": \"<string>\",\n \"zhClientId\": \"<string>\",\n \"zhAccessToken\": \"<string>\",\n \"zhClientSecret\": \"<string>\",\n \"zhOrgId\": \"<string>\",\n \"srToken\": \"<string>\",\n \"srBaseUrl\": \"<string>\",\n \"sfProjectId\": \"<string>\",\n \"sfKey\": \"<string>\",\n \"sfSecret\": \"<string>\",\n \"soProjectId\": \"<string>\",\n \"soKey\": \"<string>\",\n \"soSecret\": \"<string>\",\n \"soDomain\": \"<string>\",\n \"bsBuildingId\": \"<string>\",\n \"bsUsername\": \"<string>\",\n \"bsPassword\": \"<string>\",\n \"ftpUrl\": \"<string>\",\n \"ftpPort\": 123,\n \"ftpUsername\": \"<string>\",\n \"ftpPassword\": \"<string>\",\n \"ftpWhitelist\": \"<string>\",\n \"ftpBlacklist\": \"<string>\",\n \"ftpPath\": \"<string>\",\n \"ftpFileName\": \"<string>\",\n \"ftpMapping\": [\n {\n \"header\": \"<string>\",\n \"property\": \"<string>\"\n }\n ],\n \"colorBase\": \"<string>\",\n \"colorAccent\": \"<string>\",\n \"colorHover\": \"<string>\",\n \"colorButton\": \"<string>\",\n \"colorButtonText\": \"<string>\",\n \"colorText\": \"<string>\",\n \"colorFeatured\": \"<string>\",\n \"colorSold\": \"<string>\",\n \"colorAvailable\": \"<string>\",\n \"colorReserved\": \"<string>\",\n \"styleNavigation\": \"<string>\",\n \"styleBranding\": \"<string>\",\n \"styleFilter\": \"<string>\",\n \"styleShapes\": \"<string>\",\n \"styleFont\": \"<string>\",\n \"subscriptionItem\": \"<string>\",\n \"lastSync\": \"<string>\",\n \"lockScreen\": false,\n \"specialRankEnabled\": false,\n \"priorityList\": false,\n \"lockScreenName\": true,\n \"lockScreenEmail\": true,\n \"lockScreenPhone\": true,\n \"lockScreenMessage\": true,\n \"lockScreenCustom\": false,\n \"lockScreenCustomQuestions\": [\n {\n \"lang\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"_3dModelUrl\": \"<string>\",\n \"reportSendTo\": \"<string>\",\n \"eventsBlockList\": \"<string>\",\n \"excludeBlockedEvents\": true,\n \"enable3d\": false,\n \"_3dBuildingModelUrl\": \"<string>\",\n \"_3dFloorSelectorModelUrl\": \"<string>\",\n \"phasePrefix\": \"<string>\",\n \"hideGallery\": true,\n \"hideBedrooms\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.planpoint.io/api/project/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"_id\": \"objectId\",\n \"user\": \"objectId\",\n \"floors\": [\n \"objectId\"\n ],\n \"commercialSpaces\": [\n \"objectId\"\n ],\n \"name\": \"<string>\",\n \"websiteURL\": \"<string>\",\n \"internalURL\": \"<string>\",\n \"accentColor\": \"<string>\",\n \"showInclusions\": true,\n \"showBathrooms\": true,\n \"showAdditionalInfo\": true,\n \"showParking\": true,\n \"showOrientation\": true,\n \"brochureButtonEnabled\": true,\n \"brochureAssets\": [\n \"<string>\"\n ],\n \"customButtonEnabled\": true,\n \"customButtonOpensAt\": \"same_tab\",\n \"walkscoreEnabled\": true,\n \"walkscore\": \"<string>\",\n \"customButtonText\": \"<string>\",\n \"customButtonIcon\": \"<string>\",\n \"showAvailability\": true,\n \"hideSold\": true,\n \"showPrices\": true,\n \"initialView\": \"List\",\n \"gtmEnabled\": false,\n \"dayNightEnabled\": false,\n \"showAvailableFirst\": false,\n \"gtmHeadCode\": \"\",\n \"gtmBodyCode\": \"\",\n \"unitImageOnGrid\": \"Unit Plan\",\n \"skipFloorStep\": false,\n \"areaUnit\": \"<string>\",\n \"showUnitCustomFinishes\": false,\n \"showFloorOverview\": false,\n \"pricesStartingAt\": false,\n \"showPriceFilter\": true,\n \"showAreaFilter\": true,\n \"showUnitDescription\": false,\n \"showTaxes\": true,\n \"sharePageEnabled\": true,\n \"sharePageDescription\": \"<string>\",\n \"sharePageLogo\": \"<string>\",\n \"priceBeforeTax\": true,\n \"enableForms\": true,\n \"rentalObject\": true,\n \"deliveryDates\": true,\n \"hideArea\": false,\n \"showBranding\": true,\n \"projectImageUrl\": \"<string>\",\n \"alternativeCovers\": [\n \"<string>\"\n ],\n \"customButtonActionType\": \"url\",\n \"projectSVGUrl\": \"<string>\",\n \"svgGroupId\": \"<string>\",\n \"layoutImageUrl\": \"<string>\",\n \"formsSendTo\": \"<string>\",\n \"formsSubject\": \"<string>\",\n \"formsFromName\": \"<string>\",\n \"formsMessage\": \"<string>\",\n \"formsRedirectURL\": \"<string>\",\n \"namespace\": \"<string>\",\n \"hostName\": \"<string>\",\n \"projectLang\": \"<string>\",\n \"projectType\": \"<string>\",\n \"propertyType\": \"<string>\",\n \"lotsLayout\": \"<string>\",\n \"areaDescription\": \"<string>\",\n \"enterpriseAddressDisplay\": \"<string>\",\n \"similarSortingBy\": \"default\",\n \"onHoldExperienceEnabled\": false,\n \"onHoldMinsDuration\": 5,\n \"customFormEnabled\": false,\n \"customFormFields\": [],\n \"crfMessage\": \"<string>\",\n \"mapLayoutWidth\": 123,\n \"mapLayoutRotation\": 123,\n \"previewMode\": false,\n \"landOnly\": false,\n \"showUnitFinishes\": false,\n \"showVariants\": false,\n \"administrators\": [\n \"objectId\"\n ],\n \"editors\": [\n \"objectId\"\n ],\n \"globalAmount\": 123,\n \"chargeType\": \"same\",\n \"chargeDescription\": \"\",\n \"chargeCurrency\": \"usd\",\n \"payButtonText\": \"Pay Now\",\n \"payButtonIcon\": \"\",\n \"invites\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"level\": \"<string>\"\n }\n ],\n \"leads\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"unit\": \"<string>\",\n \"message\": \"<string>\",\n \"source\": \"<string>\",\n \"createdAt\": \"<string>\",\n \"questions\": [\n {\n \"question\": \"<string>\",\n \"answer\": \"<string>\"\n }\n ],\n \"customFields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"waitlistees\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"unit\": \"<string>\",\n \"createdAt\": \"<string>\"\n }\n ],\n \"allocations\": [\n {\n \"name\": \"<string>\",\n \"password\": \"<string>\",\n \"allocation\": \"<string>\"\n }\n ],\n \"images\": [\n \"<string>\"\n ],\n \"finishes\": [\n \"<string>\"\n ],\n \"customFinishes\": {\n \"name\": \"<string>\",\n \"options\": {\n \"kitchen\": {\n \"tabs\": [\n {\n \"label\": \"<string>\",\n \"cover\": \"<string>\",\n \"thumbnail\": \"<string>\"\n }\n ]\n },\n \"bathroom\": {\n \"tabs\": [\n {\n \"label\": \"<string>\",\n \"cover\": \"<string>\",\n \"thumbnail\": \"<string>\"\n }\n ]\n },\n \"general\": {\n \"tabs\": [\n {\n \"label\": \"<string>\",\n \"cover\": \"<string>\",\n \"thumbnail\": \"<string>\"\n }\n ]\n }\n }\n },\n \"sponsorsEnabled\": false,\n \"waitlistEnabled\": false,\n \"sponsors\": \"<string>\",\n \"layouts\": \"<string>\",\n \"downloadableAssets\": \"<string>\",\n \"floorplans\": \"<string>\",\n \"plan\": {},\n \"path\": \"<string>\",\n \"alternativePaths\": \"<string>\",\n \"invertNav\": false,\n \"address\": \"<string>\",\n \"lon\": -93.75940812944683,\n \"lat\": 43.75940812944682,\n \"zoomLevel\": 0,\n \"perimeter\": \"<string>\",\n \"markerImageUrl\": \"<string>\",\n \"targetMarker\": \"<string>\",\n \"mapStyle\": \"Light\",\n \"mapPointColor\": \"<string>\",\n \"mapDirections\": false,\n \"calUsername\": \"<string>\",\n \"calKey\": \"<string>\",\n \"payPalClientId\": \"<string>\",\n \"payPalDeposit\": 123,\n \"payPalCurrency\": \"<string>\",\n \"yiApiToken\": \"<string>\",\n \"yiCompanyCode\": \"<string>\",\n \"yiPropertyCode\": \"<string>\",\n \"yiStatusMapping\": {\n \"available\": \"<string>\",\n \"leased\": \"<string>\",\n \"sold\": \"<string>\",\n \"unavailable\": \"<string>\",\n \"reserved\": \"<string>\"\n },\n \"pvUsername\": \"<string>\",\n \"pvPassword\": \"<string>\",\n \"pvBuildingName\": \"<string>\",\n \"zhClientId\": \"<string>\",\n \"zhAccessToken\": \"<string>\",\n \"zhClientSecret\": \"<string>\",\n \"zhOrgId\": \"<string>\",\n \"srToken\": \"<string>\",\n \"srBaseUrl\": \"<string>\",\n \"sfProjectId\": \"<string>\",\n \"sfKey\": \"<string>\",\n \"sfSecret\": \"<string>\",\n \"soProjectId\": \"<string>\",\n \"soKey\": \"<string>\",\n \"soSecret\": \"<string>\",\n \"soDomain\": \"<string>\",\n \"bsBuildingId\": \"<string>\",\n \"bsUsername\": \"<string>\",\n \"bsPassword\": \"<string>\",\n \"ftpUrl\": \"<string>\",\n \"ftpPort\": 123,\n \"ftpUsername\": \"<string>\",\n \"ftpPassword\": \"<string>\",\n \"ftpWhitelist\": \"<string>\",\n \"ftpBlacklist\": \"<string>\",\n \"ftpPath\": \"<string>\",\n \"ftpFileName\": \"<string>\",\n \"ftpMapping\": [\n {\n \"header\": \"<string>\",\n \"property\": \"<string>\"\n }\n ],\n \"colorBase\": \"<string>\",\n \"colorAccent\": \"<string>\",\n \"colorHover\": \"<string>\",\n \"colorButton\": \"<string>\",\n \"colorButtonText\": \"<string>\",\n \"colorText\": \"<string>\",\n \"colorFeatured\": \"<string>\",\n \"colorSold\": \"<string>\",\n \"colorAvailable\": \"<string>\",\n \"colorReserved\": \"<string>\",\n \"styleNavigation\": \"<string>\",\n \"styleBranding\": \"<string>\",\n \"styleFilter\": \"<string>\",\n \"styleShapes\": \"<string>\",\n \"styleFont\": \"<string>\",\n \"subscriptionItem\": \"<string>\",\n \"lastSync\": \"<string>\",\n \"lockScreen\": false,\n \"specialRankEnabled\": false,\n \"priorityList\": false,\n \"lockScreenName\": true,\n \"lockScreenEmail\": true,\n \"lockScreenPhone\": true,\n \"lockScreenMessage\": true,\n \"lockScreenCustom\": false,\n \"lockScreenCustomQuestions\": [\n {\n \"lang\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"_3dModelUrl\": \"<string>\",\n \"reportSendTo\": \"<string>\",\n \"eventsBlockList\": \"<string>\",\n \"excludeBlockedEvents\": true,\n \"enable3d\": false,\n \"_3dBuildingModelUrl\": \"<string>\",\n \"_3dFloorSelectorModelUrl\": \"<string>\",\n \"phasePrefix\": \"<string>\",\n \"hideGallery\": true,\n \"hideBedrooms\": true\n}"
response = http.request(request)
puts response.read_body{
"_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
Path Parameters
Project ID
"objectId"
Body
Update an existing project
Unique identifier for the project.
"objectId"
Reference to the User associated with the project.
"objectId"
List of references to Floor documents.
List of references to CommercialSpace documents.
Name of the project.
Website URL of the project.
Internal URL for project management.
Accent color for the project branding.
Whether inclusions are displayed in the project.
Whether bathrooms are displayed in the project.
Whether additional information is displayed in the project.
Whether parking information is displayed.
Whether orientation information is displayed.
Whether the brochure button is enabled.
List of brochure asset URLs.
Whether a custom button is enabled.
Specifies where the custom button opens.
Whether Walkscore integration is enabled.
Walkscore of the project.
Text for the custom button.
Icon for the custom button.
Whether availability is displayed.
Whether sold units are hidden.
Whether prices are displayed.
Initial view mode of the project.
Whether Google Tag Manager is enabled.
Whether day-night mode is enabled.
Whether available units are shown first.
Google Tag Manager head code.
Google Tag Manager body code.
Type of unit image displayed on the grid.
Whether the floor step is skipped in navigation.
Unit of measurement for area.
Whether custom finishes for units are shown.
Whether the floor overview is displayed.
Whether prices display as 'starting at'.
Whether the price filter is displayed.
Whether the area filter is displayed.
Whether unit descriptions are displayed.
Whether taxes are displayed.
Whether the share page feature is enabled.
Description for the share page.
Logo for the share page.
Whether prices are shown before tax.
Whether forms are enabled for the project.
Whether the project is a rental property.
Whether delivery dates are displayed.
Whether the area information is hidden.
Whether branding is shown on the project page.
URL of the project's main image.
List of alternative cover images for the project.
Action type for the custom button.
URL for the project's SVG.
Group ID in the project's SVG.
URL for the project's layout image.
Email address to send forms to.
Subject line for forms submissions.
Sender name for forms submissions.
Default message for forms submissions.
URL to redirect after forms submission.
Namespace for the project.
Host name for the project.
Language for the project.
Type of project.
Property type of the project.
Layout for lots in the project.
Description for the area.
Enterprise address display details.
Method of sorting for similar items.
Whether the on-hold experience is enabled.
Duration (in minutes) for on-hold experience.
Whether custom forms are enabled.
List of custom form fields.
Custom form message.
Width for the map layout.
Rotation for the map layout.
Whether preview mode is enabled.
Whether the project is for land only.
Whether unit finishes are displayed.
Whether unit variants are displayed.
List of administrator user IDs.
List of editor user IDs.
Global amount for the project.
Charge type for the project.
Description for the charge.
Currency for charges.
Text for the payment button.
Icon for the payment button.
List of invite details.
Show child attributes
Show child attributes
List of leads.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Longitude of the project location.
-93.75940812944683
Latitude of the project location.
43.75940812944682
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Successful operation
Unique identifier for the project.
"objectId"
Reference to the User associated with the project.
"objectId"
List of references to Floor documents.
List of references to CommercialSpace documents.
Name of the project.
Website URL of the project.
Internal URL for project management.
Accent color for the project branding.
Whether inclusions are displayed in the project.
Whether bathrooms are displayed in the project.
Whether additional information is displayed in the project.
Whether parking information is displayed.
Whether orientation information is displayed.
Whether the brochure button is enabled.
List of brochure asset URLs.
Whether a custom button is enabled.
Specifies where the custom button opens.
Whether Walkscore integration is enabled.
Walkscore of the project.
Text for the custom button.
Icon for the custom button.
Whether availability is displayed.
Whether sold units are hidden.
Whether prices are displayed.
Initial view mode of the project.
Whether Google Tag Manager is enabled.
Whether day-night mode is enabled.
Whether available units are shown first.
Google Tag Manager head code.
Google Tag Manager body code.
Type of unit image displayed on the grid.
Whether the floor step is skipped in navigation.
Unit of measurement for area.
Whether custom finishes for units are shown.
Whether the floor overview is displayed.
Whether prices display as 'starting at'.
Whether the price filter is displayed.
Whether the area filter is displayed.
Whether unit descriptions are displayed.
Whether taxes are displayed.
Whether the share page feature is enabled.
Description for the share page.
Logo for the share page.
Whether prices are shown before tax.
Whether forms are enabled for the project.
Whether the project is a rental property.
Whether delivery dates are displayed.
Whether the area information is hidden.
Whether branding is shown on the project page.
URL of the project's main image.
List of alternative cover images for the project.
Action type for the custom button.
URL for the project's SVG.
Group ID in the project's SVG.
URL for the project's layout image.
Email address to send forms to.
Subject line for forms submissions.
Sender name for forms submissions.
Default message for forms submissions.
URL to redirect after forms submission.
Namespace for the project.
Host name for the project.
Language for the project.
Type of project.
Property type of the project.
Layout for lots in the project.
Description for the area.
Enterprise address display details.
Method of sorting for similar items.
Whether the on-hold experience is enabled.
Duration (in minutes) for on-hold experience.
Whether custom forms are enabled.
List of custom form fields.
Custom form message.
Width for the map layout.
Rotation for the map layout.
Whether preview mode is enabled.
Whether the project is for land only.
Whether unit finishes are displayed.
Whether unit variants are displayed.
List of administrator user IDs.
List of editor user IDs.
Global amount for the project.
Charge type for the project.
Description for the charge.
Currency for charges.
Text for the payment button.
Icon for the payment button.
List of invite details.
Show child attributes
Show child attributes
List of leads.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Longitude of the project location.
-93.75940812944683
Latitude of the project location.
43.75940812944682
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes