diff options
Diffstat (limited to 'doc/api/notification_settings.md')
| -rw-r--r-- | doc/api/notification_settings.md | 22 |
1 files changed, 10 insertions, 12 deletions
diff --git a/doc/api/notification_settings.md b/doc/api/notification_settings.md index 69bed193f07..390ba7dbd79 100644 --- a/doc/api/notification_settings.md +++ b/doc/api/notification_settings.md @@ -4,22 +4,20 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Notification settings API +# Notification settings API **(FREE)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/5632) in GitLab 8.12. +Change [notification settings](../user/profile/notifications.md) using the REST API. ## Valid notification levels The notification levels are defined in the `NotificationSetting.level` model enumeration. Currently, these levels are recognized: -```plaintext -disabled -participating -watch -global -mention -custom -``` +- `disabled` +- `participating` +- `watch` +- `global` +- `mention` +- `custom` If the `custom` level is used, specific email events can be controlled. Available events are returned by `NotificationSetting.email_events`. Currently, these events are recognized: @@ -123,7 +121,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/a | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer or string | yes | The ID, or [URL-encoded path, of the group or project](README.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID, or [URL-encoded path, of the group or project](index.md#namespaced-path-encoding). | Example response: @@ -149,7 +147,7 @@ curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer or string | yes | The ID, or [URL-encoded path, of the group or project](README.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID, or [URL-encoded path, of the group or project](index.md#namespaced-path-encoding) | | `level` | string | no | The global notification level | | `new_note` | boolean | no | Enable/disable this notification | | `new_issue` | boolean | no | Enable/disable this notification | |