v1

latestOpenAPI 3.0.12026-07-13130168404.3 KB
Content watches

Add label watcher

Adds a user as a watcher to a label. Choose the user by doing one of the following:

  • Specify a user via a query parameter: Use the accountId to identify the user.
  • Do not specify a user: The currently logged-in user will be used.

Note, you must add the X-Atlassian-Token: no-check header when making a request, as this operation has XSRF protection.

Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

post/wiki/rest/api/user/watch/label/{labelName}

Path parameters

labelNamestring required

The name of the label to add the watcher to.

Query parameters

keystring

This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.

usernamestring

This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.

accountIdstring

The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.

Headers

X-Atlassian-Tokenstring required

Note, you must add header when making a request, as this operation has XSRF protection.

Response

Returned if the watcher was successfully created. No response body is returned.