Sign in

v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
Review

Publish a custom-channel review

Publish a custom-channel review

post/reviews/custom-channel-reviews

Request body

customChannelNamestring string required
internalReservationIdstring string required

Guesty Reservation ID

externalReviewIdstring string required

Custom Source Review ID

createdAtstring date-time required

Review creation date and time

updatedAtstring date-time required

Review last update date and time

ratingnumber required

Rating

bodyTextstring string required

Review Body Text

reviewerNamestring string required

Reviewer Name

titleTextstring string

Review Title Text

localestring string

Review Texts Locale

categoryRatingsobject

A map of category names to their rating scores (integer, 1-5)

Example request

{
  "customChannelName": "Marketing Website",
  "createdAt": "2026-01-15T10:30:00.000Z",
  "updatedAt": "2026-01-15T10:30:00.000Z",
  "categoryRatings": {
    "cleanliness": 5,
    "communication": 4,
    "location": 3
  }
}

Response

Upsert Review Response

_idobject required
accountIdobject required
externalReviewIdstring string required
channelId'bookingCom' | 'airbnb2' | 'homeaway2' | 'custom' string required
customChannelNamestring string
subListingIdobject
listingIdobject required
complexIdobject
externalListingIdstring string
externalComplexIdstring string
reservationIdobject
externalReservationIdstring string
guestIdobject
createdAtstring date-time
updatedAtstring date-time
createdAtGuestystring date-time
updatedAtGuestystring date-time
rawReviewobject required

Example response

{
  "channelId": "bookingCom",
  "customChannelName": "Marketing Website A",
  "contents": {
    "locale": "en-US",
    "rating": 5
  }
}