Function: setUserProperty()

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

Defined in: src/server/api/users.ts:721

Sets the value of the specified user's property. You can use this resource to store a custom data against the user identified by the key or by the id. The user who stores the data is required to have permissions to administer the user.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ body: Record<string, any>; propertyKey: string; userKey?: string; username?: string; }	-
parameters.body	Record<string, any>	-
parameters.propertyKey?	string	The key of the user's property. The maximum length of the key is 255 bytes.
parameters.userKey?	string	Key of the user whose property is to be set
parameters.username?	string	Username of the user whose property is to be set
options?	RequestOptions	-

Returns

Promise<void>