• VillaSlotDocumentation
  • Introduction
  • Getting Started
  • API
    • Discovery
      • GETGet my context
    • Villas
      • GETList villas
      • POSTCreate a villa
      • GETGet a villa
      • PATCHRename a villa
      • POSTArchive a villa
      • POSTUpload a villa photo
      • GETGet opening hours
      • PUTReplace opening hours
      • GETGet the rate grid
      • PUTReplace the rate grid
      • GETGet availability
    • Bookings
      • GETList bookings over a period
      • POSTCreate a booking
      • GETGet a booking
      • POSTConfirm a booking
      • POSTComplete a booking
      • POSTCancel a booking
      • POSTReschedule a booking
    • Customers
      • GETList customers
      • POSTCreate a customer
      • POSTImport a batch of customers
      • GETGet a customer
      • PATCHUpdate a customer
    • Booking settings
      • GETGet booking settings
      • PATCHUpdate booking settings
  1. Documentation
  2. API
  3. Villas
  4. Archive a villa
Buydocschangelogsdemocommunity

Archive a villa

PreviousRename a villaNextUpload a villa photo
On this page
AuthorizationRequest bodyExampleResponseWhat it refuses

POST /api/v1/properties/{propertyId}/archive

Archives a villa. There is no delete in this product: archiving is a state change, and past bookings stay attached to the villa.

An archived villa disappears from the booking paths — it is no longer offered, and a booking attempt on it is refused with PROPERTY_NOT_BOOKABLE.

Idempotent: archiving an already archived villa answers 200 and changes nothing.

Authorization

Role in the organizationThis endpoint
ownerAllowed
adminAllowed
memberRefused — 403

Request body

None.

Example

bash
curl -X POST -H "x-api-key: $VILLASLOT_API_KEY" \
  "https://villaslot.app/api/v1/properties/1f0a…/archive"

Response

  • 200 OK — the villa, status: "archived".

What it refuses

  • 403 Forbidden — the key bearer is a member.
  • 401 Unauthorized — missing or invalid key, or a key whose bearer left the organization.
  • 404 Not Found — unknown id, or an id belonging to another organization. The two are deliberately indistinguishable.
  • 429 Too Many Requests — over 120 requests in a minute for this key.

Irreversible over the API. Restoring a villa is done from the app. An agent does not archive a villa without an explicit human go-ahead for that exact gesture.