---
updatedAt: 2025-09-09T21:11:12.000Z
agentTools:
  projectIndex: https://docs.ciiruspartners.com/v2023.07.31/llms.txt
---

# Check alteration availability

Returns results for checking date range availability for a property.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "security": [
    {
      "basicAuth": []
    }
  ],
  "info": {
    "title": "CiiRUS Partner API",
    "version": "2023.07.31"
  },
  "paths": {
    "/availability/{unitId}": {
      "put": {
        "summary": "Check alteration availability",
        "description": "Returns results for checking date range availability for a property.",
        "responses": {
          "200": {
            "description": "Move booking availability response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PutAvailabilityCheckUnitResponse"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          }
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/unitId"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PutAvailabilityCheckRequest"
              }
            }
          },
          "description": "Unique Identifier for inventory."
        },
        "tags": [
          "Availability (Move)"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://api.ciiruspartners.com/v2023.07.31"
    }
  ],
  "components": {
    "parameters": {
      "unitId": {
        "name": "unitId",
        "in": "path",
        "description": "Unique Identifier for inventory.",
        "required": true,
        "schema": {
          "type": "integer",
          "format": "int32",
          "minimum": 0
        }
      }
    },
    "responses": {
      "BadRequest": {
        "description": "Bad Request response",
        "content": {
          "*/*": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "Unauthorized": {
        "description": "Unauthorized response",
        "content": {
          "*/*": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "Forbidden": {
        "description": "Forbidden response",
        "content": {
          "*/*": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "NotFound": {
        "description": "Not Found response",
        "content": {
          "*/*": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    },
    "schemas": {
      "Error": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        },
        "required": [
          "code",
          "message"
        ]
      },
      "PostAvailabilityCheckRequest": {
        "required": [
          "start",
          "end"
        ],
        "allOf": [
          {
            "$ref": "#/components/schemas/start"
          },
          {
            "$ref": "#/components/schemas/end"
          }
        ]
      },
      "PutAvailabilityCheckRequest": {
        "required": [
          "booking_id"
        ],
        "allOf": [
          {
            "$ref": "#/components/schemas/PostAvailabilityCheckRequest"
          },
          {
            "type": "object"
          },
          {
            "$ref": "#/components/schemas/bookingId"
          }
        ]
      },
      "PutAvailabilityCheckResponseObject": {
        "allOf": [
          {
            "$ref": "#/components/schemas/PutAvailabilityCheckRequest"
          },
          {
            "type": "object"
          },
          {
            "$ref": "#/components/schemas/unit_id"
          },
          {
            "$ref": "#/components/schemas/is_available"
          }
        ],
        "required": [
          "unit_id",
          "is_available"
        ]
      },
      "PutAvailabilityCheckUnitResponse": {
        "allOf": [
          {
            "$ref": "#/components/schemas/PutAvailabilityCheckResponseObject"
          },
          {
            "type": "object"
          }
        ]
      },
      "bookingId": {
        "properties": {
          "booking_id": {
            "type": "integer"
          }
        }
      },
      "start": {
        "properties": {
          "start": {
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "end": {
        "properties": {
          "end": {
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "unit_id": {
        "properties": {
          "unit_id": {
            "type": "integer",
            "format": "int32",
            "description": "Unique identifier for inventory"
          }
        }
      },
      "is_available": {
        "properties": {
          "is_available": {
            "type": "boolean"
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```