View Source Turnkey.APIClient.EmailRecovery (TurnkeyEx v0.0.1-alpha2)

Our organization api key can initiate an email recovery process for a user.

https://docs.turnkey.com/api#tag/User-Recovery/operation/InitUserEmailRecovery

Summary

Functions

Create the user email recovery activity, which will send the user an email and allow them to continue the process on our recovery webpage

Functions

Link to this function

init_user_email_recovery(email, sub_organization_id, embedded_key)

View Source
@spec init_user_email_recovery(String.t(), String.t(), String.t()) ::
  {:ok, %Turnkey.APITypes.InitUserEmailRecoveryResult{userId: term()}}
  | {:error, {:instructer_parse_error, String.t()}}
  | {:error, String.t()}

Create the user email recovery activity, which will send the user an email and allow them to continue the process on our recovery webpage