Skip to main content
PUT
/
api
/
v1
/
listing
/
{id}
Update listing details
curl --request PUT \
  --url https://api.example.com/api/v1/listing/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-calry-api-key: <api-key>' \
  --data '
{
  "name": "Luxury Beach Villa",
  "internalName": "<HOST> Luxury Beach Villa",
  "description": "Beautiful beachfront villa with stunning views",
  "type": "Villa",
  "thumbnailURL": "https://example.com/thumbnail.jpg",
  "pictures": [
    {
      "url": "https://example.com/picture.jpg",
      "description": "A beautiful picture of the listing"
    }
  ],
  "address": {
    "city": "Miami Beach",
    "line1": "123 Ocean Drive",
    "state": "FL",
    "country": "USA",
    "postal_code": "70078"
  },
  "latitude": -80.1918,
  "longitude": 25.7617,
  "minimumNights": 3,
  "maximumNights": 28,
  "maxOccupancy": 10,
  "startPrice": 10,
  "currency": "AED",
  "timeZone": "Asia/Dubai",
  "bedroomCount": 3,
  "bathroomCount": 3,
  "rooms": {
    "data": [
      {
        "name": "SLEEPING_ALCOVE",
        "count": 1
      },
      {
        "name": "LIVING-DINING_ROOM",
        "count": 1
      }
    ]
  },
  "checkIn": {
    "op": "CHECK_IN",
    "end": "18:00:00",
    "start": "16:00:00"
  },
  "checkOut": {
    "op": "CHECK_OUT",
    "end": "15:00:00"
  },
  "contact": {
    "name": "John Doe",
    "firstName": "John",
    "lastName": "Doe",
    "email": [
      "[email protected]"
    ],
    "phone": [
      "+1234567890"
    ],
    "address": "123 Main St, Anytown, USA",
    "language": "en",
    "country": "USA"
  },
  "rating": {
    "count": 23,
    "average": 4.2
  },
  "providerID": "provider-listing-12345",
  "listingDetails": {
    "notes": "",
    "rules": "House rules are NON-negotiable conditions of stay.",
    "space": "",
    "access": "",
    "transit": "",
    "interaction": "",
    "instructions": "",
    "neighborhood": ""
  },
  "parentPropertyID": "<string>",
  "amenities": {}
}
'
{
  "timestamp": "2025-03-05T11:45:49.631Z",
  "path": "<URL_PATH>",
  "message": "Authentication failed",
  "details": []
}

Authorizations

x-calry-api-key
string
header
required

Headers

x-calry-tenant-id
string

Optional tenant ID to specify which tenant to operate as. If not provided, the default tenant will be used.

Path Parameters

id
string
required

Unique identifier of the listing

Example:

"123e4567-e89b-12d3-a456-426614174000"

Body

application/json
name
string

Name of the listing

Example:

"Luxury Beach Villa"

internalName
string

Internal name of the listing

Example:

"<HOST> Luxury Beach Villa"

description
string

Description of the listing

Example:

"Beautiful beachfront villa with stunning views"

type
string

Type of the property

Example:

"Villa"

thumbnailURL
string

URL of the thumbnail image of the listing

Example:

"https://example.com/thumbnail.jpg"

pictures
object[]

List of pictures of the listing

address
object

Address of the listing

Example:
{
"city": "Miami Beach",
"line1": "123 Ocean Drive",
"state": "FL",
"country": "USA",
"postal_code": "70078"
}
latitude
number

Latitude of the map marker

Example:

-80.1918

longitude
number

Longitude of the map marker

Example:

25.7617

minimumNights
number

Minimum Nights

Example:

3

maximumNights
number

Maximum Nights

Example:

28

maxOccupancy
number

Maximum Occupancy

Example:

10

startPrice
number

Start price for listing as set on provider

Example:

10

currency
string

Currency for displaying prices

Example:

"AED"

timeZone
string

Timezeone at listing

Example:

"Asia/Dubai"

bedroomCount
number

Bedroom count for the listing

Example:

3

bathroomCount
number

Bathroom count for the listing

Example:

3

rooms
object

Room information for the listing

Example:
{
"data": [
{ "name": "SLEEPING_ALCOVE", "count": 1 },
{ "name": "LIVING-DINING_ROOM", "count": 1 }
]
}
checkIn
object

Check-in information for the listing

Example:
{
"op": "CHECK_IN",
"end": "18:00:00",
"start": "16:00:00"
}
checkOut
object

Check-out information for the listing

Example:
{ "op": "CHECK_OUT", "end": "15:00:00" }
contact
object

Contact information for listing

rating
object

Rating for the property

Example:
{ "count": 23, "average": 4.2 }
providerID
string

Provider ID for the listing

Example:

"provider-listing-12345"

listingDetails
object

Listing Details

Example:
{
"notes": "",
"rules": "House rules are NON-negotiable conditions of stay.",
"space": "",
"access": "",
"transit": "",
"interaction": "",
"instructions": "",
"neighborhood": ""
}
parentPropertyID
string

Parent property ID for this listing

amenities
object

Amenities for the listing

Response

Listing updated successfully