provider Issues POST /rest/api/3/issue/{issueIdOrKey}/notify
@utdk/jira /rest/api/3/issue/{issueIdOrKey}/notify
Send notification for issue
Creates an email notification for an issue and adds it to the mail queue. **[Permissions](#permissions) required:** * *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
issueIdOrKey path required
ID or key of the issue that the notification is sent for.
string

Try it

Authentication
Configure credentials for The Jira Cloud platform REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

notify
POST/rest/api/3/issue/{issueIdOrKey}/notify
Creates an email notification for an issue and adds it to the mail queue. **[Permissions](#permissions) required:** * *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.

Parameters

required

ID or key of the issue that the notification is sent for.

Input

The HTML body of the email notification for the issue.

Restricts the notifications to users with the specified permissions.

The subject of the email notification for the issue. If this is not specified, then the subject is set to the issue key and summary.

The plain text body of the email notification for the issue.

The recipients of the email notification for the issue.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import jira from '@utdk/jira';

await jira.notify()