Reviews

  1. Overview
  2. List reviews
  3. Get a single review
  4. Create a new review
  5. Dismiss a review

Overview

his resource represents guests’ (travelers’) Reviews for the host for a given Booking.

Parameters

Group Subgroup Name Type Read/Write Description
    account Integer Read Account’s ID related to the Review
    rental Integer Read Rental’s ID related to the Review
    source Integer Read Source’s ID related to the Review
    reply Integer Read Reply’s (ReviewReply)’s ID related to the Review
    booking Integer Read Booking’s ID related to the Review
    id Integer Read Review’s ID.
    title Text Read Title/Summary of the review.
    comment Text Read Comment from traveler (guest).
    private_comment Text Read Private comment from the traveler (guest) (not meant to be exposed publicly).
    rating Integer Read/Write Overall rating of a stay
    rating_accurate Decimal Read Non-rounded rating.
    name Text Read Reviewer’s name, cropped to show only the initial of the last name.
    country_code Text Read Reviewer’s country code.
    shareable Boolean Read Whether Review is permitted for public use.
    dismissed_by Boolean Read Whom the Review was dismissed by
    dismissal_reason Boolean Read The Reason why the was dismissed
criteria     Object Read Host ratings in specific criteria.
  cleanliness   Object Read Details of given criterion.
    rating Decimal Read Was the cleanliness up to the standards?
    comment Text Read Additional feedback for a given criterion.
  communication   Object Read Details of given criterion.
    rating Decimal Read How fast/easy the communication with the host was.
    comment Text Read Additional feedback for a given criterion.
  checkin   Object Read Details of given criterion.
    rating Decimal Read How smooth was the checkin process?
    comment Text Read Additional feedback for a given criterion.
  location   Object Read Details of given criterion.
    rating Decimal Read Was the guest aware of any location dependent factors that could affect the stay (such as noise, safety, transportation etc.)?
    comment Text Read Additional feedback for a given criterion.
  facilities   Object Read Details of given criterion.
    rating Decimal Read Were facilities working and matching description?
    comment Text Read Additional feedback for a given criterion.
  comfort   Object Read Details of given criterion.
    rating Decimal Read Was the property warm enough, with enough lights. Were the beds and/or sofa comfy?
    comment Text Read Additional feedback for a given criterion.
  staff   Object Read Details of given criterion.
    rating Decimal Read Was the staff friendly, attentive and respectful?
    comment Text Read Additional feedback for a given criterion.
  value_for_money   Object Read Details of given criterion.
    rating Decimal Read Was it worth the price?
    comment Text Read Additional feedback for a given criterion.
  accuracy   Object Read Details of given criterion.
    rating Decimal Read Was the property accurately represented on a website?
    comment Text Read Additional feedback for a given criterion.
    created_at Time Read Review’s create time.
    updated_at Time Read Review’s update time.
    submitted_at Time Read Review’s submission time. When not specified, defaults to creation time.
    dismissed_at Time Read When the Review was dismissed
Group Subgroup Name Type Read/Write Description Constraints
    account Integer Read Account’s ID related to the Review  
    rental Integer Read Rental’s ID related to the Review  
    source Integer Read Source’s ID related to the Review  
    reply Integer Read Reply’s (ReviewReply)’s ID related to the Review  
    booking Integer Read Booking’s ID related to the Review  
    id Integer Read Review’s ID.  
    source_id Integer Write Source’s ID related to the Review  
    title Text Read/Write Title/Summary of the review.  
    comment Text Read/Write Comment from traveler (guest). Required
    private_comment Text Read/Write Private comment from the traveler (guest) (not meant to be exposed publicly).  
    rating Integer for Read/Decimal Read/Write Overall rating of a stay Required, must be between 1 and 5
    rating_accurate Decimal Read Non-rounded rating.  
    name Text Read Reviewer’s name, cropped to show only the initial of the last name.  
    country_code Text Read Reviewer’s country code.  
    shareable Boolean Read/Write Whether Review is permitted for public use.  
    dismissed_by Boolean Read/Write Whom the Review was dismissed by Writing possibly only via dismiss action
    dismissal_reason Boolean Read/Write The Reason why the was dismissed Writig possibly only via dismiss action
criteria     Object Read/Write Host ratings in specific criteria.  
  cleanliness   Object Read/Write Details of given criterion.  
    rating Decimal Read/Write Was the cleanliness up to the standards? Required only when sending parent node, must be between 1 and 5
    comment Text Read/Write Additional feedback for a given criterion.  
  communication   Object Read/Write Details of given criterion.  
    rating Decimal Read/Write How fast/easy the communication with the host was. Required only when sending parent node, must be between 1 and 5
    comment Text Read/Write Additional feedback for a given criterion.  
  checkin   Object Read/Write Details of given criterion.  
    rating Decimal Read/Write How smooth was the checkin process? Required only when sending parent node, must be between 1 and 5
    comment Text Read/Write Additional feedback for a given criterion.  
  location   Object Read/Write Details of given criterion.  
    rating Decimal Read/Write Was the guest aware of any location dependent factors that could affect the stay (such as noise, safety, transportation etc.)? Required only when sending parent node, must be between 1 and 5
    comment Text Read/Write Additional feedback for a given criterion.  
  facilities   Object Read/Write Details of given criterion.  
    rating Decimal Read/Write Were facilities working and matching description? Required only when sending parent node, must be between 1 and 5
    comment Text Read/Write Additional feedback for a given criterion.  
  comfort   Object Read/Write Details of given criterion.  
    rating Decimal Read/Write Was the property warm enough, with enough lights. Were the beds and/or sofa comfy? Required only when sending parent node, must be between 1 and 5
    comment Text Read/Write Additional feedback for a given criterion.  
  staff   Object Read/Write Details of given criterion.  
    rating Decimal Read/Write Was the staff friendly, attentive and respectful? Required only when sending parent node, must be between 1 and 5
    comment Text Read/Write Additional feedback for a given criterion.  
  value_for_money   Object Read/Write Details of given criterion.  
    rating Decimal Read/Write Was it worth the price? Required only when sending parent node, must be between 1 and 5
    comment Text Read/Write Additional feedback for a given criterion.  
  accuracy   Object Read/Write Details of given criterion.  
    rating Decimal Read/Write Was the property accurately represented on a website? Required only when sending parent node, must be between 1 and 5
    comment Text Read/Write Additional feedback for a given criterion.  
    created_at Time Read Review’s create time.  
    updated_at Time Read Review’s update time.  
    submitted_at Time Read/Write Review’s submission time. Default’s to current timestamp
    dismissed_at Time Read/Write When the Review was dismissed Writing possible only via dismiss action, defaults to current timestamp

List reviews

List all reviews for a given account(s).

GET /reviews

Response

{
  "links": {
    "reviews.booking": "https://www.bookingsync.com/api/v3/bookings/{reviews.booking}",
    "reviews.rental": "https://www.bookingsync.com/api/v3/rentals/{reviews.rental}"
  },
  "reviews": [
    {
      "id": 1,
      "comment": "It was awesome!",
      "country_code": "FR",
      "name": "John S.",
      "rating": 5,
      "title": "Awesome",
      "created_at": "2022-03-23T16:56:22Z",
      "updated_at": "2022-03-23T16:56:22Z",
      "links": {
        "booking": 4,
        "rental": 87
      }
    }
  ]
}

Get a single review

Returns a single review identified by ID.

GET /reviews/:review_id

Response

{
  "links": {
    "reviews.booking": "https://www.bookingsync.com/api/v3/bookings/{reviews.booking}",
    "reviews.rental": "https://www.bookingsync.com/api/v3/rentals/{reviews.rental}"
  },
  "reviews": [
    {
      "id": 1,
      "comment": "It was awesome!",
      "country_code": "FR",
      "name": "John S.",
      "rating": 5,
      "title": "Awesome",
      "created_at": "2022-03-23T16:56:22Z",
      "updated_at": "2022-03-23T16:56:22Z",
      "links": {
        "booking": 4,
        "rental": 87
      }
    }
  ]
}

Create a new review

Creates a review for given booking.

POST /bookings/:booking_id/reviews

Example JSON request

{
  "reviews": [
    {
      "comment": "It was awesome!",
      "rating": 5,
      "title": "Awesome"
    }
  ]
}

Response

{
  "links": {
    "reviews.booking": "https://www.bookingsync.com/api/v3/bookings/{reviews.booking}",
    "reviews.rental": "https://www.bookingsync.com/api/v3/rentals/{reviews.rental}"
  },
  "reviews": [
    {
      "id": 1,
      "comment": "It was awesome!",
      "country_code": "FR",
      "name": "John S.",
      "rating": 5,
      "title": "Awesome",
      "created_at": "2022-03-23T16:56:22Z",
      "updated_at": "2022-03-23T16:56:22Z",
      "links": {
        "booking": 4,
        "rental": 87
      }
    }
  ]
}

Dismiss a review

Returns an dismissed review identified by ID.

PUT /reviews/:review_id/dismiss

Example JSON request

{
  "reviews": [
    {
      "dismissal_reason": "Guest revealed personal details of a host",
      "dismissed_by": "Airbnb",
      "disimissed_at": "2022-03-10T12:00Z:00"
    }
  ]
}

Response

{
  "links": {
    "reviews.booking": "https://www.bookingsync.com/api/v3/bookings/{reviews.booking}",
    "reviews.rental": "https://www.bookingsync.com/api/v3/rentals/{reviews.rental}"
  },
  "reviews": [
    {
      "id": 1,
      "comment": "It was awesome!",
      "country_code": "FR",
      "name": "John S.",
      "rating": 5,
      "title": "Awesome",
      "created_at": "2022-03-23T16:56:22Z",
      "updated_at": "2022-03-23T16:56:22Z",
      "links": {
        "booking": 4,
        "rental": 87
      }
    }
  ]
}