🏠 Creating a Property (Accommodation)

Octorate allows you to create and manage properties (also called accommodations) through the REST API. Each property acts as a container for rooms, rates, availability, and other connected resources (extras, reservations, etc.).

---

1️⃣ Endpoint Overview

Method	Endpoint	Description	Auth Required
POST	/rest/v1/accommodation	Create a new property (accommodation)	✅ Yes — Bearer Token or API Key
GET	/rest/v1/accommodation	Retrieve all properties associated with your account	✅ Yes
PATCH	/rest/v1/accommodation/{id}	Update an existing property	✅ Yes

(Endpoints confirmed in the Octorate Postman Collection — “Property: Accommodations” section.)

---

2️⃣ Authentication

You must authenticate your request with a valid Bearer Token or API Key, as described in the Authentication page.

Example header:

Authorization: Bearer <access_token>
Content-Type: application/json

---

3️⃣ Create a New Property

To create a new property, send a POST request to:

POST https://api.octorate.com/connect/rest/v1/accommodation

Request Body

According to the official Postman documentation, the payload must contain the essential details describing your property:

{
  "name": "My Boutique Hotel",
  "category": "HOTEL",
  "country": "IT",
  "city": "Rome",
  "address": "Via del Corso 123",
  "zipCode": "00186",
  "email": "[e-mail]",
  "phone": "[phone]",
  "currency": "EUR",
  "timeZone": "Europe/Rome"
}

💡 Note: Some fields such as category, country, and timeZone must use codes supported by Octorate. You can retrieve valid values using the following meta endpoints:

• /rest/v1/meta/regions → for countries and regions

• /rest/v1/meta/content?category=ACCOMMODATION_CATEGORY → for accommodation categories

---

4️⃣ Successful Response

{
  "id": "257611",
  "name": "My Boutique Hotel",
  "currency": "EUR",
  "timeZone": "Europe/Rome",
  "country": "IT"
}

The response includes the new property’s ID, which you will use in future calls (for example, when creating rooms, rates, or reservations).

---

5️⃣ Update an Existing Property

To update property details, use the following endpoint:

PATCH https://api.octorate.com/connect/rest/v1/accommodation/{id}

Example Request

{
  "name": "My Boutique Hotel - Updated",
  "phone": "[phone]"
}

Only the fields you include will be updated; all others remain unchanged.

---

6️⃣ Retrieve All Properties

To list all properties connected to your account:

GET https://api.octorate.com/connect/rest/v1/accommodation

Example Response:

[
  {
    "id": "257611",
    "name": "My Boutique Hotel",
    "currency": "EUR",
    "country": "IT"
  },
  {
    "id": "312845",
    "name": "Seaside Apartment",
    "currency": "EUR",
    "country": "IT"
  }
]

---

Common Errors

HTTP Code	Error	Description
400	ApiParamsExemption	Missing or invalid parameter
401	ApiKeyInvalid	Invalid or expired access token
403	ApiSecurityException	You don’t have permission to access this resource
404	ApiResourceMissing	Property not found
500	InternalServerError	Unexpected error on Octorate’s side

For a more complete flow on how to create and set a property, click here