Function: removePreference()

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

Defined in: src/server/api/myPreferences.ts:57

Removes preference of the currently logged in user. Preference key must be provided as input parameters (key). If key parameter is not provided or wrong - status code 404. If preference is unset - status code 204.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ key?: string; }	-
parameters.key?	string	Key of the preference to be removed.
options?	RequestOptions	-

Returns

Promise<void>