Plum Guide is a curated platform - we only take the top 3% of homes around the world - this means we take careful consideration in curating and enriching the content on our platform.

Content on Listing Creation

On listing creation, we will accept the following content-related data through the API:

Any content not collected on listing creation will be covered in Host Onboarding.

Content Updates

Editorial Content

Plum Guide curates editorial content for the majority of our homes. You will be able to send all listing content through our API for listing creation, but the ability to update varies depending on the type of content.

Non-Editorial Content

Any changes to non-editorial content can be managed through the API.

Listing Status

The API will surface the status of the listing. If you would like to remove a listing from Plum Guide you can do so by changing the status using the PATCH Listing endpoint.

Plum Guide Statuses

Content Reference

The following sections provide detailed information about the available values for each content field.

Property Types

Specify the type of property using the propertyType field.

Example

{
  "propertyType": "Villa"
}

Cancellation Policies

Specify the cancellation policy using the cancellationPolicy field.

Example

{
  "cancellationPolicy": "Moderate"
}

House Rules

Define what is permitted at the property using the houseRules object.

Available Rules

Structure

Example

{
  "houseRules": {
    "rules": ["ChildrenOk", "InfantsOk", "PetsOk"],
    "additionalRules": "No loud music after 10 PM. Please remove shoes indoors."
  }
}

Amenities

Amenities are features and facilities available at a listing. Specify them using the amenities array.

Entertainment & Media

Wifi, TV, HomeCinemaSetup, DVDPlayer, Netflix, AmazonPrime, Sonos, SmartTV, StreamingServices, SoundSystem, RecordPlayer, Projector, DVDLibrary

Gaming

PS3, PS4, NintendoWii, XBox, GamesConsole, Playstation, BoardGames

Bedroom & Comfort

LuxuryBedding, WelcomeHamper, ExtraPillowsAndBlankets, BlackOutBlinds, CotCrib, HighChair, Hangers

Bathroom

Bathtub, Jacuzzi, RainShower, LuxuryToiletries, Bathrobes, HairDryer, HeatedTowelRail, Toiletries

Kitchen & Dining

Kitchen, Dishwasher, Microwave, PodCoffeeMachine, Cafetiere, EspressoMachine, MiniBar, CoffeeMaker, Oven, Stove, KitchenUtensils, Toaster, Fridge, Freezer, Blender, BreadMaker, CookingEssentials, DryingRack, IceMachine, Juicer, Kettle, RiceMaker

Climate Control

AirConditioning, Fan, CentralHeating, UnderfloorHeating, CeilingFans, TemperatureControl, Heating, Cooling

Laundry

WashingMachine, Dryer, LaundrySupplies, PrivateWashingMachine, SharedWashingMachine, PrivateDryer, SharedDryer, Iron, IroningBoard

Outdoor & Garden

PatioTerrace, Garden, Courtyard, Balcony, RooftopTerrace, BalconyPatio, Hammock, OutdoorSeating, GardenGames, FencedGarden, FencedProperty, OutdoorKitchen, OutdoorAudio, OutdoorFireplaceFirepit, OutdoorShower, OutdoorBathtub, SunLoungerBeachChairs, SunUmbrellas, Barbeque, HerbGarden

Pools & Spa

SwimmingPool, SharedPool, PrivatePool, OutdoorPool, IndoorPool, HeatedPool, HotTub, FencedPool, Sauna, SteamRoom, Spa, PoolHouse

Parking

ParkingAvailable, AccessibleParking, SecuredParking, PrivateParking, FreeParking, PaidParking, ParkingOnStreet, ParkingOnPremises, FreeParkingOnPremises, FreeParkingOnStreet, PaidParkingOnPremises, PaidParkingOnStreet, ValetParking

Sports & Recreation

TennisCourt, GamesRoom, SkiStorageBootRoom, SkiInAndSkiOut, Gym, ExerciseEquipment, FoosballTableFootball, PingPongTable, PoolSnookerTable, Playground, Piano

Safety & Security

AlarmSystem, TwentyFourHourSecurity, TwentyFourHourFrontDesk, SecuritySystem, SecurityCameras, SmokeDetector, CarbonMonoxideDetector, FireExtinguisher, FirstAidKit, SafetyGates, StairGates, GatedCommunity, Safe

Family & Baby

CotCrib, HighChair, BabyBath, BabyChangingMat, BabyMonitor, ChangingTable, ChildrensDinnerware, Playground, StairGates, SafetyGates

Work & Business

Desk, Workplace, LaptopFriendlyWorkspace, Printer, Projector, AccessToBusinessCentre, MeetingConferenceRooms

Access & Convenience

LiftAccess, Doorman, BuzzerWirelessIntercom, MultipleSetsOfKeys, PrivateEntrance, SelfCheckInCheckOut, EarlyLateCheckOutAvailable

Accessibility

WheelchairAccess, StepFreeAccess, SingleLevelHome, AccessibleParking

Other

Bicycles, Umbrellas, Fireplace, LibraryOfBooks, WineCooler, WineCellar, ElectricityAdaptors, VacuumCleaner, CleaningProducts, BeachPoolTowels, BeachEssentials, BikeShed, EVCharger, Helipad, MosquitoNet, PetBasket, PetBowls, ResortAccess, SmartHomeSystem, AccessToBeach, TrashCompactor, BreakfastIncluded, LuggageStorage

Example

{
  "amenities": [
    "Wifi",
    "AirConditioning",
    "SwimmingPool",
    "Dishwasher",
    "WashingMachine",
    "TV",
    "CotCrib",
    "HighChair",
    "FreeParking",
    "Gym",
    "SmartTV",
    "CoffeeMaker"
  ]
}

VIP Services

VIP Services are premium services that can be offered to guests. Specify them using the services array.

Example

{
  "services": [
    "AirportPickUp",
    "DailyCleaning",
    "Concierge247",
    "RestaurantReservations",
    "ArrangeChef"
  ]
}

Bedroom Configuration

Define the bedroom setup for your listing using the bedroomConfiguration object.

Structure

Bedroom Types

Bed Types

Example

{
  "bedroomConfiguration": {
    "isStudio": false,
    "bedrooms": [
      {
        "bedroomType": "MasterBedroom",
        "beds": ["USKingUKSuperKing"]
      },
      {
        "bedroomType": "Bedroom2",
        "beds": ["USQueenUKKing"]
      },
      {
        "bedroomType": "Bedroom3",
        "beds": ["Single", "Single"]
      },
      {
        "bedroomType": "Bedroom4",
        "beds": ["Bunkbed", "Cot"]
      }
    ]
  }
}

Bathroom Configuration

Define the bathroom setup for your listing using the bathroomConfiguration object.

Bathroom Types

Bathroom Amenities

En-Suite Configuration

To mark a bathroom as en-suite (attached to a specific bedroom), use the enSuiteTo field:

Example

{
  "bathroomConfiguration": {
    "bathrooms": [
      {
        "bathroomType": "MasterBathroom",
        "bathroomAmenities": ["Toilet", "DoubleSink", "BathWithShowerHead", "Bidet"],
        "enSuiteTo": "MasterBedroom"
      },
      {
        "bathroomType": "Bathroom2",
        "bathroomAmenities": ["Toilet", "Sink", "StandaloneShower"],
        "enSuiteTo": "Bedroom2"
      },
      {
        "bathroomType": "Bathroom3",
        "bathroomAmenities": ["Toilet", "Sink", "BathOnly"],
        "enSuiteTo": null
      }
    ]
  }
}

Communal Spaces

Define beds in communal/shared spaces (living rooms, etc.) using the communalSpaceConfiguration object. This is useful for listings where additional sleeping arrangements exist outside of designated bedrooms.

Example

{
  "communalSpaceConfiguration": {
    "communalSpaces": [
      {
        "beds": ["SofaBedDouble", "PullOutSingle"]
      }
    ]
  }
}

Regulation Data

Provide regulatory and compliance information using the regulationData object.

Fields

ManagedBy Options

Paris Property Type Options

Example

{
  "regulationData": {
    "registrationNumber": "ABC123456",
    "managedBy": "ManagementCompany",
    "parisPropertyType": "PrimaryResidence"
  }
}

Complete Request Examples

Create Listing Request

{
  "general": {
    "listingName": "Luxury Villa with Pool in Tuscany",
    "address1": "Via Roma 123",
    "postalCode": "50100",
    "latitude": 43.7696,
    "longitude": 11.2558,
    "propertyId": "PROP-12345",
    "currencyCode": "EUR",
    "checkIn": "15",
    "checkOut": "10",
    "maxOccupancy": 8,
    "securityDeposit": 500.00,
    "cancellationPolicy": "Moderate",
    "homeDescription": "Beautiful 4-bedroom villa with private pool and stunning views of the Tuscan countryside.",
    "propertyType": "Villa",
    "sizeSquareFeet": 3500,
    "instantBook": true,
    "houseManual": "Welcome to our villa! WiFi password is on the fridge.",
    "directions": "From Florence airport, take the A1 south..."
  },
  "regulationData": {
    "registrationNumber": "IT-FI-12345",
    "managedBy": "ManagementCompany"
  },
  "houseRules": {
    "rules": ["ChildrenOk", "InfantsOk"],
    "additionalRules": "No smoking inside. Pool hours 8am-8pm. Quiet hours after 10pm."
  },
  "amenities": [
    "Wifi",
    "AirConditioning",
    "PrivatePool",
    "HeatedPool",
    "OutdoorKitchen",
    "Barbeque",
    "Dishwasher",
    "WashingMachine",
    "Dryer",
    "TV",
    "CotCrib",
    "HighChair",
    "FreeParking",
    "Garden",
    "PatioTerrace",
    "OutdoorSeating",
    "SunLoungerBeachChairs"
  ],
  "services": [
    "AirportPickUp",
    "DailyCleaning",
    "FridgeFills",
    "ArrangeChef",
    "RestaurantReservations"
  ],
  "photos": [
    "https://example.com/photos/villa-exterior.jpg",
    "https://example.com/photos/pool-area.jpg",
    "https://example.com/photos/living-room.jpg",
    "https://example.com/photos/master-bedroom.jpg",
    "https://example.com/photos/kitchen.jpg",
    "https://example.com/photos/dining.jpg",
    "https://example.com/photos/bathroom.jpg",
    "https://example.com/photos/garden.jpg"
  ],
  "bedroomConfiguration": {
    "isStudio": false,
    "bedrooms": [
      {
        "bedroomType": "MasterBedroom",
        "beds": ["USKingUKSuperKing"]
      },
      {
        "bedroomType": "Bedroom2",
        "beds": ["USQueenUKKing"]
      },
      {
        "bedroomType": "Bedroom3",
        "beds": ["Double"]
      },
      {
        "bedroomType": "Bedroom4",
        "beds": ["Single", "Single"]
      }
    ]
  },
  "bathroomConfiguration": {
    "bathrooms": [
      {
        "bathroomType": "MasterBathroom",
        "bathroomAmenities": ["Toilet", "DoubleSink", "BathWithShowerHead", "StandaloneShower"],
        "enSuiteTo": "MasterBedroom"
      },
      {
        "bathroomType": "Bathroom2",
        "bathroomAmenities": ["Toilet", "Sink", "StandaloneShower"],
        "enSuiteTo": "Bedroom2"
      },
      {
        "bathroomType": "Bathroom3",
        "bathroomAmenities": ["Toilet", "Sink", "BathWithShowerHead"],
        "enSuiteTo": null
      }
    ]
  },
  "communalSpaceConfiguration": {
    "communalSpaces": [
      {
        "beds": ["SofaBedDouble"]
      }
    ]
  }
}

Update Listing Request

{
  "status": "Published",
  "currencyCode": "EUR",
  "bedroomConfiguration": {
    "isStudio": false,
    "bedrooms": [
      {
        "bedroomType": "MasterBedroom",
        "beds": ["USKingUKSuperKing"]
      },
      {
        "bedroomType": "Bedroom2",
        "beds": ["USQueenUKKing"]
      }
    ]
  },
  "bathroomConfiguration": {
    "bathrooms": [
      {
        "bathroomType": "MasterBathroom",
        "bathroomAmenities": ["Toilet", "DoubleSink", "StandaloneShower"],
        "enSuiteTo": "MasterBedroom"
      }
    ]
  }
}

Notes & Best Practices

1. Case Sensitivity: All enum values are case-sensitive. Use exact values as shown (PascalCase).

2. Required Fields: Fields marked with * in the Content on Listing Creation table are required.

3. Photo Requirements: A minimum of 8 photos is required for listing creation.

4. Sequential Numbering: Use sequential numbering for bedrooms and bathrooms starting with MasterBedroom/MasterBathroom, then Bedroom2/Bathroom2, etc.

5. En-Suite Bathrooms: Only specify enSuiteTo if the bathroom is attached to a specific bedroom. Use null for shared bathrooms.

6. Multiple Beds: A single bedroom can contain multiple beds - specify each bed in the beds array.

7. Communal Spaces: Use communal space configuration for additional sleeping arrangements outside of designated bedrooms (e.g., sofa beds in living rooms).

8. Editorial Content: Remember that photography, home descriptions, and home names are editorial content - they can be sent via POST but cannot be updated via PATCH as Plum Guide handles curation.

9. Currency Codes: Use standard 3-letter ISO 4217 currency codes (e.g., GBP, EUR, USD, CHF).

10. Latitude/Longitude: Latitude must be between -90 and 90 degrees. Longitude must be between -180 and 180 degrees.