updateReview( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates a review.

The updateReview() function returns a promise that resolves to the updated review.

Each time the review is updated, revision increments by 1. The existing revision must be included when updating the review. This ensures you're working with the latest review information, and it prevents unintended overwrites.

This function is not a universal function and runs only on the backend.

Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Reviews
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
_idstringRequired

Review ID.


reviewUpdateReviewRequired

Review to update.


optionsUpdateReviewOptions

Options to use when updating a review.

Returns
Return Type:Promise<Review>
Was this helpful?
Yes
No