Use this API to retrieve and update notification settings globally for your account, or for an individual group or project, which overrides the global setting.
Retrieve notification settings for a group
GET /api/v4/groups/{id}/notification_settings
Retrieves the notification level for a specified group.
Parameters
| Name | Type | Description |
|---|---|---|
idPath, | String | The group ID |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | APIEntities |
400 | Bad Request | — |
401 | Unauthorized | — |
404 | Not Found | — |
Update notification settings for a group
PUT /api/v4/groups/{id}/notification_settings
Updates the notification settings for a specified group.
Parameters
| Name | Type | Description |
|---|---|---|
idPath, | String | The group ID |
Request body (application/json)
| Property | Type | Description |
|---|---|---|
change_ | Boolean | Enable/ |
close_ | Boolean | Enable/ |
close_ | Boolean | Enable/ |
failed_ | Boolean | Enable/ |
fixed_ | Boolean | Enable/ |
issue_ | Boolean | Enable/ |
level | String | The group notification level |
merge_ | Boolean | Enable/ |
merge_ | Boolean | Enable/ |
moved_ | Boolean | Enable/ |
new_ | Boolean | Enable/ |
new_ | Boolean | Enable/ |
new_ | Boolean | Enable/ |
new_ | Boolean | Enable/ |
push_ | Boolean | Enable/ |
reassign_ | Boolean | Enable/ |
reassign_ | Boolean | Enable/ |
reopen_ | Boolean | Enable/ |
reopen_ | Boolean | Enable/ |
success_ | Boolean | Enable/ |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | APIEntities |
400 | Bad request | — |
401 | Unauthorized | — |
404 | Not Found | — |
Retrieve global notification settings
GET /api/v4/notification_settings
Retrieves the global notification level and email address.
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | APIEntities |
401 | Unauthorized | — |
Update global notification settings
PUT /api/v4/notification_settings
Updates notification settings and email address.
Request body (application/json)
| Property | Type | Description |
|---|---|---|
change_ | Boolean | Enable/ |
close_ | Boolean | Enable/ |
close_ | Boolean | Enable/ |
failed_ | Boolean | Enable/ |
fixed_ | Boolean | Enable/ |
issue_ | Boolean | Enable/ |
level | String | The global notification level |
merge_ | Boolean | Enable/ |
merge_ | Boolean | Enable/ |
moved_ | Boolean | Enable/ |
new_ | Boolean | Enable/ |
new_ | Boolean | Enable/ |
new_ | Boolean | Enable/ |
new_ | Boolean | Enable/ |
notification_ | String | The email address to send notifications |
push_ | Boolean | Enable/ |
reassign_ | Boolean | Enable/ |
reassign_ | Boolean | Enable/ |
reopen_ | Boolean | Enable/ |
reopen_ | Boolean | Enable/ |
success_ | Boolean | Enable/ |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | APIEntities |
400 | Bad request | — |
401 | Unauthorized | — |
Retrieve notification settings for a project
GET /api/v4/projects/{id}/notification_settings
Retrieves the notification level for a specified project.
Parameters
| Name | Type | Description |
|---|---|---|
idPath, | String | The project ID |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | APIEntities |
400 | Bad Request | — |
401 | Unauthorized | — |
404 | Not Found | — |
Update notification settings for a project
PUT /api/v4/projects/{id}/notification_settings
Updates the notification settings for a specified project.
Parameters
| Name | Type | Description |
|---|---|---|
idPath, | String | The project ID |
Request body (application/json)
| Property | Type | Description |
|---|---|---|
change_ | Boolean | Enable/ |
close_ | Boolean | Enable/ |
close_ | Boolean | Enable/ |
failed_ | Boolean | Enable/ |
fixed_ | Boolean | Enable/ |
issue_ | Boolean | Enable/ |
level | String | The project notification level |
merge_ | Boolean | Enable/ |
merge_ | Boolean | Enable/ |
moved_ | Boolean | Enable/ |
new_ | Boolean | Enable/ |
new_ | Boolean | Enable/ |
new_ | Boolean | Enable/ |
new_ | Boolean | Enable/ |
push_ | Boolean | Enable/ |
reassign_ | Boolean | Enable/ |
reassign_ | Boolean | Enable/ |
reopen_ | Boolean | Enable/ |
reopen_ | Boolean | Enable/ |
success_ | Boolean | Enable/ |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | APIEntities |
400 | Bad request | — |
401 | Unauthorized | — |
404 | Not Found | — |
Schemas
Objects returned by the operations above and objects nested in their request bodies.
APIEntitiesGlobalNotificationSetting
| Property | Type | Description |
|---|---|---|
events | String | — |
level | String | — |
notification_ | String | — |
APIEntitiesNotificationSetting
| Property | Type | Description |
|---|---|---|
events | String | — |
level | String | — |