Edit Account
Use the Edit Account screen to update a user’s personal information and access security controls. 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.
- Download or Delete Account controls when enabled for the user.
- An Update button that save changes.
- A link that returns to the Account screen.
Workflow
-
From the Account screen, select Edit Account.
-
Update one or more profile fields:
- First Name
- Last Name
- Mobile Number (include country code)
-
To save changes, select Update.
-
To update account security:
-
Select Edit Password to open the Change Password screen.
-
Select 2-Step Verification to open the MFA Setup screen.
-
Validations
| Scenario | App Behavior | SDK Output |
|---|---|---|
| Session is not active. | Blocks access and displays the login screen. | Returns an unauthenticated state. |
| Mobile number format is invalid. | Highlights the field and disables Update. | Returns a validation error for invalid phone format. |
| Required fields contain invalid or empty values. | Disables the Update button. | Returns validation error metadata. |
| Session expires while in the editor. | Disables access to security links and account updates. | Emits onSessionExpired. |
Actions
| Scenario | App Behavior | SDK Output |
|---|---|---|
| User selects Update. | Sends updated profile information to /account/edit. | Returns the updated profile payload. |
| User selects Edit Password. | Opens the Change Password screen. | Returns the current password state and security metadata. |
| User selects 2-Step Verification. | Opens the Set up MFA or Unlink Authenticator App screen depending on current status. | Returns MFA state and enabled authentication methods. |
| User selects Back. | Returns to the Account screen. | Returns the existing session and profile context. |
Endpoint Resources
Edit Account (Retrieve Editable Fields)
PUT
/account/edit
Returns editable profile fields for the authenticated user.
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 | — |
Update Account Details
POST
/account/edit
Updates the authenticated doctor’s profile.
Send the required fields for first name, last name, and mobile 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. |


