Update a review

Updated:

PUT/property/{connection_id}/review/{id}

Updates the PropertyReview identified by id. Provide the unified PropertyReview fields to change in the request body.

Parameters

fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection
idstring required
ID of the Review

Payload

idstring
unique identifier for the review
created_atdate-time
when the review was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
when the review was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
listing_idstring
pointer to the Property Listing that was reviewed
reservation_idstring
pointer to the Property Reservation that was reviewed
guest_idstring
pointer to the Property Guest who wrote the review
author_namestring
the reviewer name
sourcestring
the channel the review was posted on, eg. Airbnb
titlestring
the review title
contentstring
the review text
ratingnumber
the overall rating
category_ratings array
ratings per category
private_feedbackstring
private feedback for the host
responsestring
the host public reply
responded_atdate-time
when the host replied (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
is_publicboolean
whether the review is publicly visible
metadata array
custom field values

Returns

Response fieldTypeRequiredDescription
idstringNounique identifier for the review
created_atstring (date-time)Nowhen the review was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)Nowhen the review was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
listing_idstringNopointer to the Property Listing that was reviewed
reservation_idstringNopointer to the Property Reservation that was reviewed
guest_idstringNopointer to the Property Guest who wrote the review
author_namestringNothe reviewer name
sourcestringNothe channel the review was posted on, eg. Airbnb
titlestringNothe review title
contentstringNothe review text
ratingnumberNothe overall rating
category_ratingsPropertyCategoryrating[]Noratings per category
category_ratings[].categoryenumNothe rated category Values: CLEANLINESS, ACCURACY, COMMUNICATION, CHECKIN, LOCATION, VALUE, OTHER
category_ratings[].ratingnumberNothe category rating
category_ratings[].commentstringNothe guest comment for this category
private_feedbackstringNoprivate feedback for the host
responsestringNothe host public reply
responded_atstring (date-time)Nowhen the host replied (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
is_publicbooleanNowhether the review is publicly visible
metadataPropertyMetadata[]Nocustom field values
metadata[].idstringNothe custom field identifier
metadata[].slugstringNothe custom field key
metadata[].valueobjectNothe custom field value
metadata[].namespacestringNothe scope or origin of the custom field
metadata[].formatenumNothe data type of the value Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNoadditional data about the custom field

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'PUT',
  url: 'https://api.unified.to/property/5de520f96e439b002043d8dc/review/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?