Notifications User Profile

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

Resource	/api/users/{userID}/profiles/notifications
Returned entity	NotificationsUserProfile. For the description of the entity attributes, see Supported Fields section.

NotificationsUserProfile attributes

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

Below you can find the list of resources that let you work with this entity.

This table describes attributes of the NotificationsUserProfile entity.

To receive an attribute in the response from the server, specify it explicitly in the fields request parameter.
To update an attribute, provide it in the body of a POST request.

Field	Type	Description
id	String	The ID of the NotificationsUserProfile. `Read-only`.
notifyOnOwnChanges	Boolean	Indicates whether the user receives notifications on their own changes.
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 or article updates when they leave a comment.
autoWatchOnCreate	Boolean	Indicates whether the user is automatically subscribed to the issue or article updates when they create it.
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 or article updates when they update it.

Last modified: 7 November 2024