Channel Password Setup


Endpoint

POST


Attributes

hotelid alphanumeric (Required)

Specifies the required node hotelid contains the IT provider's hotel id for which the provider wishes to add mapping information.


action enum (Required)

Indicates the call is meant to OTA setup for property.

circle-info

Possible values:

  • "setup" → Performs both create and update operations. If the channel password does not exist in the system, it will create it; otherwise, it will update the existing one.

  • "remove" → Directly performs a straightforward remove operation.


channelid numeric (Required)

Specifies the Channel Code for OTA in Su. For IRCTC - 282


status string (Required)

Defines the status of the channel connection in the system.

circle-info

Possible values:

  • "Active" → Channel integration is enabled.

  • "Inactive" → Channel integration is disabled.


defaultmultiplier number (Required)

Defines the default multiplier value to be applied in rateplan mapping.


defaultsurcharge number (Required)

Specifies the default surcharge value to be applied in rateplan mapping.


currency string (Required)

Specifies the currency code to be used for channel pricing.


convertrates boolean (Optional)

Indicates whether the system should automatically convert prices for channel into the configured currency.


rating number (Optional)

Specifies the star rating of the hotel or property.


description string (Optional)

Provides the descriptive content of the hotel or property, including highlights and general information.


policies array (Optional)

Specifies the list of policy identifiers applicable to the hotel or property.


friendly array (Optional)

Defines a list of features, amenities, or tags indicating what the property is friendly towards (for example: Pet friendly).


notfriendly array (Optional)

Defines a list of features, amenities, or tags indicating restrictions or what the property is not friendly towards.(for example: No smoking).


notes array (Optional)

Specifies additional informational notes related to the hotel or property configuration.


connection_name string (Optional)

Provides a unique name for the hotel connection to identify it easily in dashboards and reports.


Sample Request


Response


Success Response - Body Elements


Status string

Indicates the result of the API call.

circle-info

Will be "Success" for successful operations.


channelhotelid integer

Represents the unique hotel ID generated by the system, to be shared with the channel to establish the connection from their side.


Errors Response - Body Elements

Status string

Indicates the result of the API call, which will be always "Failed" in case of an error response.


Errors array

Array that contains details about any errors that occurred during the API call. Each object in the Errors array contains the following properties:

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.

Last updated

Was this helpful?