Deregister a Phone
Removes a phone number from the user's profile in Transmit
Description
This step is used to remove a phone number from the user's profile in Mosaic (from their secondary phone numbers). A phone number is added to the user's profile using the Register a Phone step and retrieved using the Get User Phones step.
For example, if the user changes their phone number, they can remove their old phone number from their profile. Once removed, it should no longer be considered a known phone number for the user and shouldn't be used for SMS-based authentication flows.
If the step is successfully completed, the journey removes the phone number 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. |
| Phone | Phone number to unregister, specified as an expression. It must yield a phone number in E.164 format (e.g., +14155552671). |
| 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). |