Edit Account
Use the Edit Account screen to update a doctor’s personal information and manage security preferences. This screen requires an active session and is accessible from the Account screen.
This screen includes:
- Editable fields for First Name, Last Name, and Mobile Number (with country code).
- A read-only Email Address field.
- A Change Password link → Change Password.
- A 2-Step Verification link → MFA Setup.
- Options to Download or Delete Account (if available).
- An Update button to save changes.
- A link to return to the Account screen.
Workflow
-
From the Account screen, select Edit Account.
-
Update one or more of the following fields:
- First Name
- Last Name
- Mobile Number (include country code)
-
To save changes, select Update.
-
To manage account security:
-
Select Edit Password to open the [Change Password] screen.
-
Select 2-Step Verification to open the [MFA Setup] screen.
-
Validations
- Requires an active session
- Validates the phone number format (must include country code).
- Disables the Update button if any required field is invalid.
- Disables Change Password and 2-Step Verification links if the session expires.
Actions
- Sends updated profile information to
/account/edit. - Redirects to:
- Change Password to update the password.
- Set up MFA or Unlink Authenticator App, depending on the current MFA state.
- Returns to the Account screen after saving changes.
SDK and API References
- SDK Reference
- API Reference
GET
/account/edit
Returns the doctor’s editable profile data from the current session.
UI Element Types
| Level | Reference | Type | Value | Placement |
|---|---|---|---|---|
| 1 | email | Email address | — | |
| 1 | first-name | Edit | First name | — |
| 1 | last-name | Edit | Last name | — |
| 1 | phone | Phone | Mobile number | — |
| 1 | edit-password | Link | Edit password | — |
| 1 | security | Link | Security settings | — |
| 1 | spacer | Spacer | — | — |
| 1 | update | Button | Save updates | — |
POST
/account/edit
Updates the authenticated doctor's profile.
Include the required fields to change the first name, last name, and phone number. The request requires an active session.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
first-name | String | Yes | Doctor's first name |
last-name | String | Yes | Doctor's last name |
phone | String | Yes | Doctor's mobile number |
Errors
| Code | Description |
|---|---|
FIELDS_VALIDATION_ERROR | One or more required fields are invalid. |