YouTrack InCloud 2019.1 Help

Operations with Specific NotificationsUserProfile

Resource

/api/admin/customFieldSettings/bundles/user/{bundleID}/individuals/{userID}/profiles/notifications

Returned entity

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

Supported methods

NotificationsUserProfile attributes

User's data related to notifications.

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

If user receives notifications on his own changes.

jabberNotificationsEnabled

Boolean

If notifications via jabber are enabled.

emailNotificationsEnabled

Boolean

If notifications via email are enabled.

mentionNotificationsEnabled

Boolean

If user receives notifications when he is mentioned in issue text.

duplicateClusterNotificationsEnabled

Boolean

If user receives notifications about issue's duplicates.

mailboxIntegrationNotificationsEnabled

Boolean

If user receives notifications produced by mailbox integration.

usePlainTextEmails

Boolean

If user receives emails in plain text.

autoWatchOnComment

Boolean

If when user leaves a comment he is automatically subscribed to issue updates.

autoWatchOnVote

Boolean

If when user votes for an issue he is automatically subscribed to issue updates.

autoWatchOnUpdate

Boolean

If when user updates and issue he is automatically subscribed to issue updates.

Read a Specific NotificationsUserProfile

Get profile with user's notifications settings.

Request syntax

GET /api/admin/customFieldSettings/bundles/user/{bundleID}/individuals/{userID}/profiles/notifications/{profileID}?{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.

Update a Specific NotificationsUserProfile

Request syntax

POST /api/admin/customFieldSettings/bundles/user/{bundleID}/individuals/{userID}/profiles/notifications/{profileID}?{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.

Last modified: 17 May 2019