Review Replies
Overview
This resource represents replies to guest or host reviews. A review reply can belong exclusively to either a guest review OR a host review, but not both.
Parameters
- OAuth Scopes:
- public
- reviews_write
Name | Type | Read/Write | Description |
---|---|---|---|
account | Integer | Read | Account's ID related to the Review Reply |
guest_review | Integer | Read | Guest Review's (Review) ID related to the Review Reply (mutually exclusive with host_review) |
host_review | UUID | Read | Host Review's (Host Review) ID related to the Review Reply (mutually exclusive with guest_review) |
id | UUID | Read | Review Reply's ID. |
message | Text | Read | Reply to given Guest or Host review |
submitted_at | Time | Read | Review Reply's submission time. |
created_at | Time | Read | Review Reply's create time. |
updated_at | Time | Read | Review Reply's update time. |
Name | Type | Read/Write | Description | Constraints |
---|---|---|---|---|
account | Integer | Read | Account's ID related to the Review Reply | |
guest_review | Integer | Read | Guest Review's (Review) ID related to the Review Reply (mutually exclusive with host_review) | |
host_review | UUID | Read | Host Review's (Host Review) ID related to the Review Reply (mutually exclusive with guest_review) | |
id | UUID | Read | Review Reply's ID. | |
message | Text | Read/Write | Reply to given Guest or Host review | Required |
submitted_at | Time | Read/Write | Review Reply's submission time. When not provided it will be set to creation time. | |
created_at | Time | Read | Review Reply's create time. | |
updated_at | Time | Read | Review Reply's update time. |
List review replies
List all review replies for a given account(s).
GET /review_replies
Response
- OAuth Scopes:
- public
response.json
{
"links": {
"review_replies.booking": "https://www.bookingsync.com/api/v3/bookings/{review_replies.booking}",
"review_replies.host_review": "https://www.bookingsync.com/api/v3/host_reviews/{review_replies.host_review}",
"review_replies.guest_review": "https://www.bookingsync.com/api/v3/reviews/{review_replies.guest_review}",
"review_replies.account": "https://www.bookingsync.com/api/v3/accounts/{review_replies.account}"
},
"review_replies": [
{
"links": {
"host_review": "111-2222-3333-4444-555555555555",
"guest_review": null,
"booking": 111,
"account": 222
},
"id": "333-4444-5555-6666-777777777777",
"message": "Thank you for your stay!",
"submitted_at": "2023-12-01T14:30:00Z",
"created_at": "2023-12-01T14:30:00Z",
"updated_at": "2023-12-01T14:30:00Z"
}
],
"meta": {}
}
Get a single review reply
Returns a single review reply identified by ID.
GET /review_replies/:review_reply_id
Response
- OAuth Scopes:
- public
response.json
{
"links": {
"review_replies.booking": "https://www.bookingsync.com/api/v3/bookings/{review_replies.booking}",
"review_replies.host_review": "https://www.bookingsync.com/api/v3/host_reviews/{review_replies.host_review}",
"review_replies.guest_review": "https://www.bookingsync.com/api/v3/reviews/{review_replies.guest_review}",
"review_replies.account": "https://www.bookingsync.com/api/v3/accounts/{review_replies.account}"
},
"review_replies": [
{
"links": {
"host_review": "111-2222-3333-4444-555555555555",
"guest_review": null,
"booking": 111,
"account": 222
},
"id": "333-4444-5555-6666-777777777777",
"message": "Thank you for your stay!",
"submitted_at": "2023-12-01T14:30:00Z",
"created_at": "2023-12-01T14:30:00Z",
"updated_at": "2023-12-01T14:30:00Z"
}
],
"meta": {}
}
Reply to guest or host review
info
As of now, every guest or host review may have only one reply. A review reply can belong exclusively to either a guest review OR a host review, but not both.
Reply to guest review
Replies to a given guest review
POST /reviews/:review_id/reply
Request
- OAuth Scopes:
- reviews_write
request.json
{
"review_replies": [
{
"message": "Thank you for the wonderful review! We're so glad you enjoyed your stay and hope to welcome you back again soon.",
"submitted_at": "2023-12-01T15:45:00Z"
}
]
}
response.json
{
"links": {
"review_replies.booking": "https://www.bookingsync.com/api/v3/bookings/{review_replies.booking}",
"review_replies.host_review": "https://www.bookingsync.com/api/v3/host_reviews/{review_replies.host_review}",
"review_replies.guest_review": "https://www.bookingsync.com/api/v3/reviews/{review_replies.guest_review}",
"review_replies.account": "https://www.bookingsync.com/api/v3/accounts/{review_replies.account}"
},
"review_replies": [
{
"links": {
"host_review": null,
"guest_review": 333,
"booking": 111,
"account": 222
},
"id": "444-5555-6666-7777-888888888888",
"message": "Thank you for the wonderful review!",
"submitted_at": "2023-12-01T15:45:00Z",
"created_at": "2023-12-01T15:45:00Z",
"updated_at": "2023-12-01T15:45:00Z"
}
],
"meta": {}
}
Reply to host review
Replies to a given host review
POST /host_reviews/:host_review_id/reply
Request
- OAuth Scopes:
- reviews_write
request.json
{
"review_replies": [
{
"message": "Thank you for the wonderful review! We're so glad you enjoyed your stay and hope to welcome you back again soon.",
"submitted_at": "2023-12-01T15:45:00Z"
}
]
}
response.json
{
"links": {
"review_replies.booking": "https://www.bookingsync.com/api/v3/bookings/{review_replies.booking}",
"review_replies.host_review": "https://www.bookingsync.com/api/v3/host_reviews/{review_replies.host_review}",
"review_replies.guest_review": "https://www.bookingsync.com/api/v3/reviews/{review_replies.guest_review}",
"review_replies.account": "https://www.bookingsync.com/api/v3/accounts/{review_replies.account}"
},
"review_replies": [
{
"links": {
"host_review": "111-2222-3333-4444-555555555555",
"guest_review": null,
"booking": 111,
"account": 222
},
"id": "333-4444-5555-6666-777777777777",
"message": "Thank you for your stay!",
"submitted_at": "2023-12-01T14:30:00Z",
"created_at": "2023-12-01T14:30:00Z",
"updated_at": "2023-12-01T14:30:00Z"
}
],
"meta": {}
}