Skip to content

Function: removePreference() ​

ts
function removePreference(
   client, 
   parameters, 
   options?
): Promise<void>;

Defined in: src/cloud/api/myself.ts:118

Deletes a preference of the user, which restores the default value of system defined settings.

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.

Use Update a user profile from the user management REST API to manage timezone and locale instead.

Permissions required: Permission to access Jira.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ key: string; }-
parameters.keystringThe key of the preference.
options?RequestOptions-

Returns ​

Promise<void>