{ "opencollection": "1.0.0", "info": { "name": "Atlassian Admin Account Issue Notification Schemes API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Issue Notification Schemes", "type": "folder" }, "items": [ { "info": { "name": "Atlassian Get Projects Using Notification Schemes Paginated", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/notificationscheme/project", "params": [ { "name": "startAt", "value": "", "type": "query", "description": "The index of the first item to return in a page of results (page offset)." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "notificationSchemeId", "value": "", "type": "query", "description": "The list of notifications scheme IDs to be filtered out" }, { "name": "projectId", "value": "", "type": "query", "description": "The list of project IDs to be filtered out" } ] }, "docs": "Returns a [paginated](#pagination) mapping of project that have notification scheme assigned. You can provide either one or multiple notification scheme IDs or project IDs to filter by. If you don't provide any, this will return a list of all mappings. Note that only company-managed (classic) projects are supported. This is because team-managed projects don't have a concept of a default notification scheme. The mappings are ordered by projectId.

**[Permissions](#permissions) required:** P" }, { "info": { "name": "Atlassian Get Notification Scheme", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/notificationscheme/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the notification scheme. Use [Get notification schemes paginated](#api-rest-api-3-notificationscheme-get) to get a list of notification scheme IDs." }, { "name": "expand", "value": "", "type": "query", "description": "Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `all` Returns all expandable information\n * `field` Returns information about any custom fields assigned to receive an event\n * `group` Returns information about any groups assigned to receive an event\n * `notificationSchemeEvents` Returns a list of event associations. This list is returned for all expandable information\n * `projectRole` Returns information about any project roles assigned to receive an event\n * `user` Returns information about any users assigned to receive an event" } ] }, "docs": "Returns a [notification scheme](https://confluence.atlassian.com/x/8YdKLg), including the list of events and the recipients who will receive notifications for those events.

**[Permissions](#permissions) required:** Permission to access Jira, however, the user must have permission to administer at least one project associated with the notification scheme." }, { "info": { "name": "Atlassian Update Notification Scheme", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/rest/api/3/notificationscheme/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the notification scheme." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a notification scheme.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." }, { "info": { "name": "Atlassian Add Notifications To Notification Scheme", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/rest/api/3/notificationscheme/:id/notification", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the notification scheme." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds notifications to a notification scheme. You can add up to 1000 notifications per request.

*Deprecated: The notification type `EmailAddress` is no longer supported in Cloud. Refer to the [changelog](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-1031) for more details.*

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." }, { "info": { "name": "Atlassian Delete Notification Scheme", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/rest/api/3/notificationscheme/:notificationSchemeId", "params": [ { "name": "notificationSchemeId", "value": "", "type": "path", "description": "The ID of the notification scheme." } ] }, "docs": "Deletes a notification scheme.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." }, { "info": { "name": "Atlassian Remove Notification From Notification Scheme", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/rest/api/3/notificationscheme/:notificationSchemeId/notification/:notificationId", "params": [ { "name": "notificationSchemeId", "value": "", "type": "path", "description": "The ID of the notification scheme." }, { "name": "notificationId", "value": "", "type": "path", "description": "The ID of the notification." } ] }, "docs": "Removes a notification from a notification scheme.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." }, { "info": { "name": "Atlassian Get Notification Schemes Paginated", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/notificationscheme", "params": [ { "name": "startAt", "value": "", "type": "query", "description": "The index of the first item to return in a page of results (page offset)." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "id", "value": "", "type": "query", "description": "The list of notification schemes IDs to be filtered by" }, { "name": "projectId", "value": "", "type": "query", "description": "The list of projects IDs to be filtered by" }, { "name": "onlyDefault", "value": "", "type": "query", "description": "When set to true, returns only the default notification scheme. If you provide project IDs not associated with the default, returns an empty page. The default value is false." }, { "name": "expand", "value": "", "type": "query", "description": "Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `all` Returns all expandable information\n * `field` Returns information about any custom fields assigned to receive an event\n * `group` Returns information about any groups assigned to receive an event\n * `notificationSchemeEvents` Returns a list of event associations. This list is returned for all expandable information\n * `projectRole` Returns information about any project roles assigned to receive an event\n * `user` Returns information about any users assigned to receive an event" } ] }, "docs": "Returns a [paginated](#pagination) list of [notification schemes](https://confluence.atlassian.com/x/8YdKLg) ordered by the display name.

*Note that you should allow for events without recipients to appear in responses.*

**[Permissions](#permissions) required:** Permission to access Jira, however, the user must have permission to administer at least one project associated with a notification scheme for it to be returned." }, { "info": { "name": "Atlassian Create Notification Scheme", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/rest/api/3/notificationscheme", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a notification scheme with notifications. You can create up to 1000 notifications per request.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." } ] } ], "bundled": true }