Deregister an Email

Removes an email address from the user's profile in Transmit

Description

This step is used to remove an email address from the user's profile in Mosaic (from their secondary emails). An email is added to the user's profile using the Register an Email step and retrieved using the Get User Emails step.

For example, if the user changes their email address or no longer has access to the registered email, they can remove it from their profile. Once removed, it should no longer be considered a known email for the user and shouldn't be used for email-based authentication flows.

If the step is successfully completed, the journey removes the email from the user's profile and continues to the next step. If it fails, the journey proceeds to a failure branch (if one is specified); otherwise, the journey is aborted and an error is sent to the client.

Configuration

Field Description
User Auth State Indicates if the user has authenticated in this journey. If the user is authenticated (default), the user context is provided implicitly by the journey. If not, a user identifier must be configured.
User Identifier User identifier, specified as an expression. Only configured if the journey doesn't authenticate the user before invoking this step.
Email Email address to unregister, specified as an expression
Error Output Variable Name of the variable that stores any errors returned by step
Failure Behavior Determines the behavior in case of failure, which either aborts the journey or proceeds to a failure branch of the control flow (default).