Property Deactivation and Activation API

This endpoint activates or deactivates a hotel property based on the provided hotel ID, with an option to force deactivation when dependencies exist.

Endpoint

POST


Attributes

hotelid string (Required)

Hotel id for which you want to activate or deactivate the property.

circle-info

Maximum 20 characters allowed.


is_activate integer (Required)

Indicates whether the property should be activated or deactivated.

circle-info

Allowed Values:

  • 1 → Activate

  • 0 → Deactivate


force_deactivation boolean (Optional)

This flag applies only when deactivating a property. It has no effect during property activation.

When set to true, all channel passwords associated with the property will be forcefully deactivated and the property itself will be deactivated.

When omitted or set to false, the deactivation request will fail with an error if any channel password associated with the property is still active.

circle-info

Default: false

Allowed Values:

  • If true, the system will deactivate the property regardless of constraints.

  • If false, deactivation may fail if blocking conditions exist.


Sample Request


Response

Sample Success Response


Success Response - Body Elements

Status string

Indicates the result of the API call.

circle-info

Will be "Success" for successful operations.


Message string

The message in the response.

circle-info

Message: Property Status Activated Successfully


Error

Sample Error Response


Error Response Body Elements

Response Body Elements

Error object

The error response data, the root element.


Code string

Specific error code that helps identify the type of error.

circle-info

For example: "400" indicates a bad request.


ShortText string

A short description of the error.

Indicates channel room id and rate id.


Status string

Indicates the result of the API call.

circle-info

Will be "Fail" for failed operations.

Last updated

Was this helpful?