Skip to content

Function: deleteIssue() ​

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

Defined in: src/server/api/issues.ts:458

Deletes an issue. If the issue has subtasks you must set the parameter deleteSubtasks=true to delete the issue. You cannot delete an issue without its subtasks also being deleted.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ deleteSubtasks?: string; issueIdOrKey: string; }-
parameters.deleteSubtasks?stringA String of true or false indicating that any subtasks should also be deleted. If the issue has no subtasks this parameter is ignored. If the issue has subtasks and this parameter is missing or false, then the issue will not be deleted and an error will be returned.
parameters.issueIdOrKey?stringIssue id or key
options?RequestOptions-

Returns ​

Promise<void>