Skip to content

Function: setPreference() ​

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

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

Sets preference of the currently logged in user. Preference key must be provided as input parameters (key). Value must be provided as post body. If key or value parameter is not provided - status code 404. If preference is set - status code 204.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ body?: string; key?: string; }-
parameters.body?string-
parameters.key?stringKey of the preference to be set.
options?RequestOptions-

Returns ​

Promise<void>