---
title: "Send notification for issue"
method: POST
path: "/rest/api/2/issue/{issueIdOrKey}/notify"
tags: ["Issues"]
---

# Send notification for issue

`POST /rest/api/2/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.

## Path parameters

- `issueIdOrKey` string, required

## Request body

- Notification — Details about a notification.
  - `htmlBody` string — The HTML body of the email notification for the issue.
  - `restrict` NotificationRecipientsRestrictions — Details of the group membership or permissions needed to receive the notification.
    - `groupIds` string[] — List of groupId memberships required to receive the notification.
    - `groups` GroupName[] — List of group memberships required to receive the notification.
      - `groupId` string, nullable — The ID of the group, which uniquely identifies the group across all Atlassian products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*.
      - `name` string — The name of group.
      - `self` string, uri — The URL for these group details.
    - `permissions` RestrictedPermission[] — List of permissions required to receive the notification.
      - `id` string — The ID of the permission. Either `id` or `key` must be specified. Use [Get all permissions](#api-rest-api-2-permissions-get) to get the list of permissions.
      - `key` string — The key of the permission. Either `id` or `key` must be specified. Use [Get all permissions](#api-rest-api-2-permissions-get) to get the list of permissions.
  - `subject` string — 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 — The plain text body of the email notification for the issue.
  - `to` NotificationRecipients — Details of the users and groups to receive the notification.
    - `assignee` boolean — Whether the notification should be sent to the issue's assignees.
    - `groupIds` string[] — List of groupIds to receive the notification.
    - `groups` GroupName[] — List of groups to receive the notification.
      - `groupId` string, nullable — The ID of the group, which uniquely identifies the group across all Atlassian products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*.
      - `name` string — The name of group.
      - `self` string, uri — The URL for these group details.
    - `reporter` boolean — Whether the notification should be sent to the issue's reporter.
    - `users` UserDetails[] — List of users to receive the notification.
      - `accountId` string — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
      - `accountType` string — The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)
      - `active` boolean — Whether the user is active.
      - `avatarUrls` AvatarUrlsBean
        - `16x16` string, uri — The URL of the item's 16x16 pixel avatar.
        - `24x24` string, uri — The URL of the item's 24x24 pixel avatar.
        - `32x32` string, uri — The URL of the item's 32x32 pixel avatar.
        - `48x48` string, uri — The URL of the item's 48x48 pixel avatar.
      - `displayName` string — The display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
      - `emailAddress` string — The email address of the user. Depending on the user’s privacy settings, this may be returned as null.
      - `key` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
      - `name` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
      - `self` string — The URL of the user.
      - `timeZone` string — The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.
    - `voters` boolean — Whether the notification should be sent to the issue's voters.
    - `watchers` boolean — Whether the notification should be sent to the issue's watchers.

## Response `204`

Returned if the email is queued for sending.

- unknown

## Other responses

- `400` — Returned 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 issueIdOrKey is of an invalid/null issue. * the request is invalid. For example, required fields are missing or have invalid values.
- `403` — Returned if: * outgoing emails are disabled. * no SMTP server is configured.
- `404` — Returned if the issue is not found.

---

[API](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api.md) · [All operations](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/the-jira-cloud-platform-rest-api/versions/a26541c2f8bd/schema)