Skip to main content

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

  1. From the Account screen, select Edit Account.

  2. Update one or more profile fields:

    • First Name
    • Last Name
    • Mobile Number (include country code)
  3. To save changes, select Update.

  4. To update account security:


Validations

ScenarioApp BehaviorSDK 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

ScenarioApp BehaviorSDK 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

LevelReferenceTypeValuePlacement
1emailEmailEmail address
1first-nameEditFirst name
1last-nameEditLast name
1phonePhoneMobile number
1edit-passwordLinkEdit password
1securityLinkSecurity settings
1spacerSpacer
1updateButtonSave 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

NameTypeRequiredDescription
first-nameStringYesDoctor's first name
last-nameStringYesDoctor's last name
phoneStringYesDoctor's mobile number

Errors

CodeDescription
FIELDS_VALIDATION_ERROROne or more required fields are invalid.