Skip to main content
function linkEmail(email: string, options?: {
  idempotencyKey?: string;
}): Promise<{
  flowId: string;
  message: string;
}>;
Links an email account to the current user.

​
Parameters

ParameterTypeDescription
emailstringThe email address to link.
options?{ idempotencyKey?: string; }Optional options for the link operation.
options.idempotencyKey?stringOptional idempotency key for safe retries.

​
Returns

Promise<{ flowId: string; message: string; }> The result of the link email initiation.