Skip to navigation

Update a review

View as Markdown

Partially update a review belonging to this directory. Accepts any subset of title, company, summary, first_name, last_name, email, rating, and status — at least one field must be provided. entry_id is immutable: a review cannot be reassigned to a different partner entry. When status is included and differs from the current status, approver bookkeeping is updated automatically: transitioning to A (approved) sets approvedBy to the caller and clears declinedBy; transitioning to D (declined) does the inverse. Status values other than A/D leave both fields untouched. Requires the generic_directory:update_reviews permission.

Authentication

AuthorizationToken

Your API key, sent as Authorization: Token <your API key>

Path parameters

directoryIdstringRequiredformat: "uuid"
UUID of the generic directory that owns the review.
reviewIdstringRequiredformat: "uuid"
UUID of the review to update.

Request

This endpoint expects an object.
titlestringOptional1-80 characters
companystringOptional<=60 characters
summarystringOptional1-1000 characters
firstNamestringOptional1-30 characters
lastNamestringOptional1-30 characters
emailstringOptionalformat: "email"1-80 characters
ratingintegerOptional1-5
statusenumOptional
  • A - approved
  • D - declined
  • P - pending
  • R - replied
Allowed values:

Response

Updated review.
idstringformat: "uuid"
entryobject
entryTypestring
titlestring
companystring or null
summarystring
shortSummarystring
firstNamestring
lastNamestring
emailstring or nullformat: "email"
ratinginteger
createddatetime
statusstring
statusDisplaystring
approvedByobject or null
declinedByobject or null
partnerReplyobject or null

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error