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:

Field	Notes
listingName*
address1*
postalCode*
latitude*
longitude*
airbnbId	Unique ID for Airbnb
propertyId*	The property's internal ID
sourcePropertyId	If a Channel Manager, then this is the host's internal ID for the listing, as opposed to the Channel Manager's internal ID
currencyCode*	3-letter ISO 4217 currency code (e.g., GBP, EUR, USD)
externalUrl	A URL that displays the property on any website
checkIn*	Check-in time in 24-hour format (e.g., "14" for 2 PM)
checkOut*	Check-out time in 24-hour format (e.g., "10" for 10 AM)
maxOccupancy*
securityDeposit*
sizeSquareFeet
floor	The floor number the apartment is on, please select 0 if the property is a home
houseManual
directions
instantBook
cancellationPolicy*	See Cancellation Policies
homeDescription*
propertyType	See Property Types
registrationNumber
managedBy	See Regulation Data
parisPropertyType	Only applicable if the home is located in Paris. See Regulation Data
rules*	6 key policies related to a listing. See House Rules
additionalRules
amenities*	See Amenities
services	VIP or additional services available. See VIP Services
photos*	Minimum of 8 photos required
additionalFees
bedroomType*	See Bedroom Configuration
beds*	See Bed Types
bathroomType*	See Bathroom Configuration
bathroomAmenities*	See Bathroom Amenities
enSuiteTo	See En-Suite Configuration

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.

	Available to send via POST Listing	Available to update via PATCH Listing	How is it used by Plum Guide?
Photography	Yes	No	Photos will be used to vet the listing, then enhanced if necessary, and used in the gallery of the listing page
Home Description	Yes	No	Depending on a variety of factors, Plum Guide will write our own Home Description or use the Home Description available through the API.
Home Name	Yes	No	Plum Guide gives all homes their own unique name
Neighbourhood Information	No	No	Plum Guide writes its own neighbourhood description for all neighbourhoods

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

Status	Description
`InReview`	Indicates the Listing is undergoing Host Onboarding
`Published`	Indicates the Listing is live on the Plum Guide platform and can actively take bookings
`Delist`	Indicates the Listing has been removed from the Plum Guide platform and will no longer be visible. Delisting properties can happen at any point in time if we feel the Listing no longer meets our standard

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.

Value	Description
`Apartment`	Standard apartment
`Townhouse`	Townhouse property
`Loft`	Loft-style property
`WarehouseConversion`	Converted warehouse space
`Houseboat`	Houseboat accommodation
`Penthouse`	Penthouse apartment
`Flat`	Flat (UK terminology)
`House`	Standalone house
`Villa`	Villa property
`BnB_GuestHouse`	B&B or Guest House
`Cottage_Bungalow_Lodge_Cabin`	Cottage, Bungalow, Lodge, or Cabin
`Aparthotels`	Aparthotel accommodation
`HotelBoutique_Hotel_Alternatives`	Boutique Hotel or Hotel Alternative

Example

{
  "propertyType": "Villa"
}

Cancellation Policies

Specify the cancellation policy using the cancellationPolicy field.

Value	Description
`Relaxed`	Most flexible cancellation terms
`Reasonable`	Standard reasonable cancellation terms
`Moderate`	Moderate cancellation restrictions
`Firm`	Firm cancellation policy
`SuperFirm`	Very strict cancellation policy
`SuperFirm30Day`	Super firm with 30-day notice requirement
`SuperFirm60Day`	Super firm with 60-day notice requirement

Example

{
  "cancellationPolicy": "Moderate"
}

House Rules

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

Available Rules

Value	Description
`ChildrenOk`	Children are welcome
`InfantsOk`	Infants are welcome
`PetsOk`	Pets are allowed
`SmokingOk`	Smoking is permitted
`FilmingOk`	Filming/photography is allowed
`PartiesOk`	Parties/events are permitted

Structure

Field	Type	Description
`rules`	array	Array of rule types that are permitted
`additionalRules`	string	Free-text field for any additional house rules

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.

Value	Description
`AirportPickUp`	Airport pickup/transfer service
`FridgeFills`	Pre-arrival grocery/fridge stocking
`DailyCleaning`	Daily housekeeping service
`LaudryDryCleaning`	Laundry and dry cleaning service
`BabySitting`	Babysitting/childcare service
`RestaurantReservations`	Restaurant booking assistance
`TicketsAndExperienceBooking`	Event tickets and experience booking
`Massage`	In-home massage service
`CabBooking`	Taxi/cab booking service
`LocalPhoneSim`	Local phone or SIM card provision
`Concierge247`	24/7 concierge service
`LuggageStorage`	Luggage storage facility
`ArrangeChef`	Private chef arrangement

Example

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

Bedroom Configuration

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

Structure

Field	Type	Description
`isStudio`	bool	Set to `true` if the listing is a studio apartment
`bedrooms`	array	Array of bedroom configurations

Bedroom Types

Value	Description
`MasterBedroom`	Primary/main bedroom
`Bedroom2` - `Bedroom30`	Additional bedrooms (numbered 2-30)

Bed Types

Value	Description
`SmallSingle`	Small single bed
`Single`	Standard single bed
`Bunkbed`	Bunk bed
`SmallDouble`	Small double bed
`Double`	Standard double bed
`USQueenUKKing`	US Queen / UK King size bed
`USKingUKSuperKing`	US King / UK Super King size bed
`PullOutSingle`	Pull-out single bed
`PullOutDouble`	Pull-out double bed
`SofaBedSingle`	Single sofa bed
`SofaBedDouble`	Double sofa bed
`FutonSingle`	Single futon
`FutonDouble`	Double futon
`Cot`	Baby cot/crib

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

Value	Description
`MasterBathroom`	Primary/main bathroom
`Bathroom2` - `Bathroom30`	Additional bathrooms (numbered 2-30)

Bathroom Amenities

Value	Description
`Toilet`	Standard toilet fixture
`Sink`	Single sink basin
`DoubleSink`	Double sink basin
`BathOnly`	Bathtub without shower capability
`BathWithShowerHead`	Bathtub with an attached shower head
`StandaloneShower`	Separate shower enclosure
`WetRoom`	Open wet room style bathroom
`Bidet`	Bidet fixture

En-Suite Configuration

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

Value	Description
`MasterBedroom`	En-suite to master bedroom
`Bedroom2` - `Bedroom30`	En-suite to specific bedroom
`null`	Shared bathroom (not en-suite)

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

Field	Type	Description
`registrationNumber`	string	Official registration number for the listing
`managedBy`	enum	Who manages the property
`parisPropertyType`	enum	Paris-specific property classification (Paris listings only)

ManagedBy Options

Value	Description
`Individual`	Managed by an individual owner
`ManagementCompany`	Managed by a property management company

Paris Property Type Options

Value	Description
`PrimaryResidence`	Primary residence (limited rental days)
`MobilityLeaseAgreement`	Under mobility lease agreement
`CommercialResidence`	Commercial/professional residence

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

Case Sensitivity: All enum values are case-sensitive. Use exact values as shown (PascalCase).
Required Fields: Fields marked with * in the Content on Listing Creation table are required.
Photo Requirements: A minimum of 8 photos is required for listing creation.
Sequential Numbering: Use sequential numbering for bedrooms and bathrooms starting with MasterBedroom/MasterBathroom, then Bedroom2/Bathroom2, etc.
En-Suite Bathrooms: Only specify enSuiteTo if the bathroom is attached to a specific bedroom. Use null for shared bathrooms.
Multiple Beds: A single bedroom can contain multiple beds - specify each bed in the beds array.
Communal Spaces: Use communal space configuration for additional sleeping arrangements outside of designated bedrooms (e.g., sofa beds in living rooms).
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.
Currency Codes: Use standard 3-letter ISO 4217 currency codes (e.g., GBP, EUR, USD, CHF).
Latitude/Longitude: Latitude must be between -90 and 90 degrees. Longitude must be between -180 and 180 degrees.