deleteComment( )

Developer Preview

Deletes a comment.

Description

This endpoint deletes the content of the comment and sets its status to DELETED.

Admin Method

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

Syntax

function deleteComment(commentId: string): Promise<void>

deleteComment Parameters

NAME

TYPE

DESCRIPTION

commentId

string

ID of the Comment to delete.

Returns

Return Type:

Promise<

void

Was this helpful?

deleteComment example

Copy Code

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