• 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. Rename a villa
Buydocschangelogsdemocommunity

Rename a villa

PreviousGet a villaNextArchive a villa
On this page
AuthorizationRequest bodyExampleResponseWhat it refuses

PATCH /api/v1/properties/{propertyId}

Renames a villa. Nothing else moves: the photo, the archive state and the nightly rate are separate gestures, on purpose — renaming must not silently clear a photo.

Authorization

Role in the organizationThis endpoint
ownerAllowed
adminAllowed
memberRefused — 403

Request body

FieldTypeRequiredDescription
namestringyes1 to 120 characters

Example

bash
curl -X PATCH -H "x-api-key: $VILLASLOT_API_KEY" -H "content-type: application/json" \
  -d '{"name":"Villa Suar — Beachfront"}' \
  "https://villaslot.app/api/v1/properties/1f0a…"

Response

  • 200 OK — the updated villa.

What it refuses

  • 403 Forbidden — the key bearer is a member.
  • 422 Unprocessable Entity — the name is missing or too long.
  • 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.