v1

latestOpenAPI 3.0.32026-07-2632131.4 MB

Custom Fields

Delete Custom Field from property

Delete a specific custom field value from property

delete/properties-api/custom-fields/{propertyId}/{fieldId}

Path parameters

propertyIdstring required

The Guesty property ID.

fieldIdstring required

The custom field ID.

Query parameters

updateSubUnitsboolean

Should also update MultiUnit SubUnits (if applicable)? False by default.

Response

Returns a list of all custom fields set on property

propertyIdstring

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"
        }
      ]
    }
  ]
}