v1
latestOpenAPI 3.0.32026-07-2632131.4 MBCustom Fields
Update property Custom Fields
Update many custom fields of property at once. It will only update custom fields of property, if You need to remove other fields please use DELETE endpoint
put/properties-api/custom-fields/{propertyId}
Path parameters
propertyIdstring required
The Guesty property ID.
Query parameters
updateSubUnitsboolean
Should also update MultiUnit SubUnits (if applicable)? False by default.
Request body
Response
Returns a list of all custom fields set on property
Example response
{
"customFields": [
{
"propertyId": "5aa90b5a23f67f001f4115b6",
"customFields": [
{
"fieldId": "5bf14ff5163f2e0037331fe1",
"displayName": "Some Field",
"key": "test",
"type": "text",
"options": [
"value 1",
"value 2"
],
"isPublic": true,
"value": "value 1"
},
{
"fieldId": "5b5ed0e7e359ca0040894648",
"displayName": "Do I?",
"key": "doi",
"type": "boolean",
"options": [],
"isPublic": true,
"value": "true"
},
{
"fieldId": "5b1e5e4317b4b9002afab4bd",
"displayName": "How to access WiFI?",
"key": "wifi_access",
"type": "longtext",
"options": [],
"isPublic": true,
"value": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eu venenatis risus. Phasellus ...",
"fullText": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa.\n\nCum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate"
}
]
}
]
}