Function: setEmail()

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

Defined in: src/userManagement/api/email.ts:10

Sets the specified user's email address. Before using this endpoint, you must verify the target domain as the new email address will be considered verified. The permission to make use of this resource is exposed by the email.set privilege. This call invalidates all active sessions.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ accountId: string; email: string; }	-
parameters.accountId	string	The ID of the user
parameters.email?	string	-
options?	RequestOptions	-

Returns

Promise<void>