Function: deleteUserProperty()

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

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

Removes the property from the user identified by the key or by the id. The user who removes the property is required to have permissions to administer the user.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ propertyKey: string; userKey?: string; username?: string; }	-
parameters.propertyKey	string	The key of the user's property
parameters.userKey?	string	Key of the user whose property is to be removed
parameters.username?	string	Username of the user whose property is to be removed
options?	RequestOptions	-

Returns

Promise<void>