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* | |
| externalUrl | A URL that displays the property on any website |
| checkIn* | |
| checkOut* | |
| maxOccupancy* | |
| securityDeposit* | |
| sizeSquareFeet | |
| floor | The floor number the apartment is on, please select 0 if the property is a home |
| houseManual | |
| directions | |
| instantBook | |
| cancellationPolicy* | Please refer to our Cancellation Policies page |
| homeDescription* | |
| propertyType | |
| registrationNumber | |
| managedBy | |
| parisPropertyType | Only applicable if the home is located in Paris |
| rules* | 6 key policies related to a listing |
| additionalRules | |
| amenities* | |
| services | VIP or additional services available |
| photos* | Minimum of 8 photos required |
| additionalFees | |
| bedroomType* | |
| beds* | |
| bathroomType* | |
| bathroomAmenities* | |
| enSuiteTo |
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
- 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.