YouTrack Standalone 2019.2 Help

Operations with Specific NotificationsUserProfile

This resource lets you read and update notification settings in the profile of the specific user.

Resource

/api/admin/users/{userID}/profiles/notifications

Returned entity

NotificationsUserProfile. For the description of the entity attributes, see Supported Fields section.

Supported methods

NotificationsUserProfile attributes

Represents the notification settings in the profile of the specific user.

This table describes attributes of the NotificationsUserProfile entity.

  • To receive an attribute in the response from server, specify it explicitly in the request parameter fields.

  • To update an attribute, provide it in the body of a POST request.

Field

Type

Description

notifyOnOwnChanges

Boolean

Indicates whether the user receives notifications on their own changes.

jabberNotificationsEnabled

Boolean

Indicates whether the user enabled notifications via jabber.

emailNotificationsEnabled

Boolean

Indicates whether the user enabled notifications via email.

mentionNotificationsEnabled

Boolean

Indicates whether the user receives notifications when they is mentioned in issue text.

duplicateClusterNotificationsEnabled

Boolean

Indicates whether the user receives notifications about issue's duplicates.

mailboxIntegrationNotificationsEnabled

Boolean

Indicates whether the user receives notifications produced by mailbox integration.

usePlainTextEmails

Boolean

Indicates whether the user receives emails in plain text.

autoWatchOnComment

Boolean

Indicates whether the user is automatically subscribed to the issue updates when they leave a comment.

autoWatchOnVote

Boolean

Indicates whether the user is automatically subscribed to the issue updates when they vote for the issue.

autoWatchOnUpdate

Boolean

Indicates whether the user is automatically subscribed to the issue updates when they update the issue.

Read a Specific NotificationsUserProfile

Get notification settings of the specific user profile.

Request syntax

GET /api/admin/users/{userID}/profiles/notifications?{fields}

Request parameters

Parameter

Type

Description

fields

String

A list of NotificationsUserProfile attributes that should be returned in the response. If no field is specified,only the entityID is returned

Sample

Sample request URI

https://example.myjetbrains.com/youtrack/api/admin/users/1-2/profiles/notifications?fields=id,notifyOnOwnChanges,jabberNotificationsEnabled,emailNotificationsEnabled,mentionNotificationsEnabled,duplicateClusterNotificationsEnabled,mailboxIntegrationNotificationsEnabled,usePlainTextEmails,autoWatchOnComment,autoWatchOnVote,autoWatchOnUpdate

Sample response body

{ "emailNotificationsEnabled": true, "autoWatchOnComment": true, "autoWatchOnUpdate": false, "autoWatchOnVote": true, "notifyOnOwnChanges": false, "jabberNotificationsEnabled": true, "mailboxIntegrationNotificationsEnabled": true, "usePlainTextEmails": false, "mentionNotificationsEnabled": true, "duplicateClusterNotificationsEnabled": false, "id": "notificationsProfile", "$type": "NotificationsUserProfile" }

Update a Specific NotificationsUserProfile

Change notification settings in the specific user profile.

Request syntax

POST /api/admin/users/{userID}/profiles/notifications?{fields}

Request parameters

Parameter

Type

Description

fields

String

A list of NotificationsUserProfile attributes that should be returned in the response. If no field is specified,only the entityID is returned

Sample

Let's disable Jabber notifications and notifications from a mailbox integrations for the user.

Sample request URI

https://example.myjetbrains.com/youtrack/api/admin/users/1-2/profiles/notifications?fields=jabberNotificationsEnabled,emailNotificationsEnabled,mailboxIntegrationNotificationsEnabled

Sample request body

{ "jabberNotificationsEnabled": false, "mailboxIntegrationNotificationsEnabled": false }

Sample response body

{ "emailNotificationsEnabled": true, "jabberNotificationsEnabled": false, "mailboxIntegrationNotificationsEnabled": false, "$type": "NotificationsUserProfile" }
Last modified: 22 October 2019