Skip to content

Function: deleteComment() ​

ts
function deleteComment(
   client, 
   parameters, 
   options?
): Promise<void>;

Defined in: src/cloud/api/issueComments.ts:245

Deletes a comment.

Permissions required:

  • Browse projects project permission for the project that the issue containing the comment is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
  • Delete all comments project permission to delete any comment or Delete own comments to delete comment created by the user,
  • If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ id: string; issueIdOrKey: string; }-
parameters.idstringThe ID of the comment.
parameters.issueIdOrKey?stringThe ID or key of the issue.
options?RequestOptions-

Returns ​

Promise<void>