Send notification for issue

Creates an email notification for an issue and adds it to the mail queue.

Permissions required:

Browse Projects project permission for the project that the issue is in.

If issue-level security is configured, issue-level security permission to view the issue.

curl --location --request POST 'http://jira.local:8080/jira/rest//rest/api/3/issue//notify' \ --header 'Content-Type: application/json' \ --data-raw '{ "htmlBody": "The <strong>latest</strong> test results for this ticket are now available.", "restrict": { "groupIds": [], "groups": [ { "name": "notification-group" } ], "permissions": [ { "key": "BROWSE" } ] }, "subject": "Latest test results", "textBody": "The latest test results for this ticket are now available.", "to": { "assignee": false, "groupIds": [], "groups": [ { "name": "notification-group" } ], "reporter": false, "users": [ { "accountId": "5b10a2844c20165700ede21g", "active": false } ], "voters": true, "watchers": true } }'

Request

Path Params

issueIdOrKey

string

required

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

Body Params application/json

Details about a notification.

htmlBody

string

optional

The HTML body of the email notification for the issue.

restrict

object

optional

Restricts the notifications to users with the specified permissions.

groupIds

array[string]

optional

List of groupId memberships required to receive the notification.

groups

array[object (GroupName) {2}]

optional

List of group memberships required to receive the notification.

permissions

array[object (RestrictedPermission) {3}]

optional

List of permissions required to receive the notification.

subject

string

optional

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.

textBody

string

optional

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

object

optional

The recipients of the email notification for the issue.

assignee

boolean

optional

Whether the notification should be sent to the issue's assignees.

groupIds

array[string]

optional

List of groupIds to receive the notification.

groups

array[object (GroupName) {2}]

optional

List of groups to receive the notification.

reporter

boolean

optional

Whether the notification should be sent to the issue's reporter.

users

array [object]

optional

List of users to receive the notification.

voters

boolean

optional

Whether the notification should be sent to the issue's voters.

watchers

boolean

optional

Whether the notification should be sent to the issue's watchers.

Additional properties

integer | number | string | boolean

optional

Additional properties

integer | number | string | boolean

optional

Examples

Responses

🟢204Returned if the email is queued for sending.

application/json

Body

No schema defined

🟠400Returned if: * the recipient is the same as the calling user. * the recipient is invalid. For example, the recipient is set to the assignee, but the issue is unassigned. * the request is invalid. For example, required fields are missing or have inv

🟠403Returned if: * outgoing emails are disabled. * no SMTP server is configured.

🟠404Returned if the issue is not found.