PUT /rest/api/2/mypreferences
Creates a preference for the user or updates a preference's value by sending a plain text string. For example, false. An arbitrary preference can be created with the value containing up to 255 characters. In addition, the following keys define system preferences that can be set or created:
- user.notifications.mimetype The mime type used in notifications sent to the user. Defaults to
html. - user.default.share.private Whether new filters are set to private. Defaults to
true. - user.keyboard.shortcuts.disabled Whether keyboard shortcuts are disabled. Defaults to
false. - user.autowatch.disabled Whether the user automatically watches issues they create or add a comment to. By default, not set: the user takes the instance autowatch setting.
- user.notifiy.own.changes Whether the user gets notified of their own changes.
Note that these keys are deprecated:
- jira.user.locale The locale of the user. By default, not set. The user takes the instance locale.
- jira.user.timezone The time zone of the user. By default, not set. The user takes the instance timezone.
These system preferences keys will be deprecated by 15/07/2024. You can still use these keys to create arbitrary preferences, but it will not have any impact on Notification behaviour.
- user.notifications.watcher Whether the user gets notified when they are watcher.
- user.notifications.assignee Whether the user gets notified when they are assignee.
- user.notifications.reporter Whether the user gets notified when they are reporter.
- user.notifications.mentions Whether the user gets notified when they are mentions.
Use Update a user profile from the user management REST API to manage timezone and locale instead.
Permissions required: Permission to access Jira.
Servers
- https://your-domain.atlassian.net
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
key |
String | Yes |
The key of the preference. The maximum length is 255 characters. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.