Developer Portal for YouTrack and Hub Help

WatchFolder

A WatchFolder is an IssueFolder that lets you enable notifications for a set of issues that it enfolds. It is a common abstract ancestor for saved searches and issue tags.

Extends IssueFolder

Extended by:

This table describes attributes of the WatchFolder 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 watch folder. Read-only.

owner

User

A user who created — hence, owns — the watch folder. Read-only. Can be null.

visibleFor

UserGroup

Deprecated. Use the readSharingSettings attribute instead.

Group of users that can see this watch folder. If the folder is visible only for its owner, this property is null.

Can be null.

updateableBy

UserGroup

Deprecated. Use the updateSharingSettings attribute instead.

Group of users that can update this watch folder. If only the folder's owner can update it, this property is null.

Can be null.

readSharingSettings

WatchFolderSharingSettings

Users and groups that can see this watch folder. If the folder is visible only for its owner, this property contains an empty array. Read-only.

updateSharingSettings

WatchFolderSharingSettings

Users and groups that can update this watch folder. If only the folder's owner can update it, this property contains an empty array. Read-only.

name

String

The name of the issue folder. Can be null.

Last modified: 9 May 2022