is_hidden Boolean status marker specific for Airbnb reviews. If true, that mean review is created but will be visible when Property Owner provide they feedback to Guest.
is_replied Boolean status marker which represent has Review reply from Property Owner or not.
ota String. Name of OTA associated with Review.
ota_reservation_id String which contain code of Reservation associated with Review.
overall_score Float value which represent Overall score of Review. Max is 10.
reply String with reply Property Owner to Guest Review
scores List with detailed information about scores provided by Guest.
tags List of Strings with codes of Review Tags. (Only for Airbnb).
This error happened, when Property is not have installed Messages Application.
Returns
Success
Method can return a Success result with 200 OK HTTP Code if operation is successful. Will contain a Reviews list in the answer.
Unauthorised Error
Method can return a Unauthorised Error result with 401 Unauthorized HTTP Code if wrong Bearer Token provided or User not have access to requested Booking.
Not Found Error
Method can return a Not Found Error result with 404 Not Found HTTP Code if Booking with provided ID is not present at system.
Forbidden Error
Method can return a Forbidden Error result with 403 Forbidden HTTP Code if Property, associated with requested Booking, is not connected to Messages Application.
Get Review by ID
Request:
GET https://staging.channex.io/api/v1/reviews/:review_id
Success
Method can return a Success result with 200 OK HTTP Code if operation is successful. Will contain a Review list in the answer.
Unauthorised Error
Method can return a Unauthorised Error result with 401 Unauthorized HTTP Code if wrong Bearer Token provided or User not have access to requested Booking.
Not Found Error
Method can return a Not Found Error result with 404 Not Found HTTP Code if Booking with provided ID is not present at system.
Forbidden Error
Method can return a Forbidden Error result with 403 Forbidden HTTP Code if Property, associated with requested Booking, is not connected to Messages Application.
Reply to Review
Request:
POST https://staging.channex.io/api/v1/reviews/:review_id/reply
{"errors": {"code":"not_found","title":"Resouce Not Found" }}
Returns
Success
Method can return a Success result with 200 OK HTTP Code if operation is successful. Will contain a Review in the answer.
Unauthorised Error
Method can return a Unauthorised Error result with 401 Unauthorized HTTP Code if wrong Bearer Token provided or User not have access to requested Message Thread.
Not Found Error
Method can return a Not Found Error result with 404 Not Found HTTP Code if Message Thread with provided ID is not present at system.
Send Guest Review
Method specific only to Airbnb reviews.
Request:
POST https://staging.channex.io/api/v1/reviews/:review_id/guest_review
{"errors": {"code":"not_found","title":"Resouce Not Found" }}
Returns
Success
Method can return a Success result with 200 OK HTTP Code if operation is successful. Will contain a Review in the answer.
Unauthorised Error
Method can return a Unauthorised Error result with 401 Unauthorized HTTP Code if wrong Bearer Token provided or User not have access to requested Message Thread.
Not Found Error
Method can return a Not Found Error result with 404 Not Found HTTP Code if Message Thread with provided ID is not present at system.
Tags
Scores
API to read Score per Property
Get Property Score
Request:
GET https://staging.channex.io/api/v1/scores/:property_id
{"errors": {"code":"not_found","title":"Resouce Not Found" }}
Returns
Success
Method can return a Success result with 200 OK HTTP Code if operation is successful. Will contain a Score in the answer.
Unauthorised Error
Method can return a Unauthorised Error result with 401 Unauthorized HTTP Code if wrong Bearer Token provided or User not have access to requested Message Thread.
Not Found Error
Method can return a Not Found Error result with 404 Not Found HTTP Code if Message Thread with provided ID is not present at system.Close Message Thread
Get Detailed Property Scores
Request:
GET https://staging.channex.io/api/v1/scores/:property_id/detailed
{"errors": {"code":"not_found","title":"Resouce Not Found" }}
Returns
Success
Method can return a Success result with 200 OK HTTP Code if operation is successful. Will contain a Score and OTA Scores in the answer.
Unauthorised Error
Method can return a Unauthorised Error result with 401 Unauthorized HTTP Code if wrong Bearer Token provided or User not have access to requested Message Thread.
Not Found Error
Method can return a Not Found Error result with 404 Not Found HTTP Code if Message Thread with provided ID is not present at system.