deleteReview( )

Developer Preview

Deletes a review.

Description

The deleteReview() function returns a promise that resolves to the deleted review.

Admin Method

This function requires elevated permissions to run. This function is not universal and runs only on the backend.

Syntax

function deleteReview(reviewId: string): Promise<DeleteReviewResponse>

deleteReview Parameters

NAME

TYPE

DESCRIPTION

reviewId

string

Review ID.

Returns

Return Type:

Promise<

DeleteReviewResponse

NAME

TYPE

DESCRIPTION

review

Review

Review entity.

Was this helpful?

deleteReview example

Copy Code

1import { reviews } from 'wix-reviews.v2';
2  
3 async function deleteReview(reviewId) {
4   try {
5     const result = await reviews.deleteReview(reviewId);
6
7     return result;
8   } catch (error) {
9     console.error(error);
10     // Handle the error
11   }
12 }
13