Skip to main content

Edit Account


Use the Edit Account screen to update profile information and access account security and data controls. This screen requires an active session and is accessible from the Account screen.



This screen includes:

#ElementDescription
1HeaderDisplays Edit account title and back navigation
2Email address fieldRead-only account email address
3First name fieldEditable required first name
4Last name fieldEditable required last name
5Phone number fieldEditable required phone number with country code selector
6Change Password linkOpens the Change Password screen
7Security–2 step verification linkOpens MFA setup or management
8Manage my private data linkOpens personal data controls
9Save changes actionSaves profile updates

Workflow

  1. Open the Account screen.
  2. Select Edit account.
  3. Update profile fields as needed.
  4. Select Save changes.
  5. Select a security or data option when needed:
    • Change Password
    • Security–2 step verification
    • Manage my private data

Validations

ScenarioApp BehaviorSDK Output
Session missing or expiredBlock access and require sign instate = unauthenticated
Required profile field emptyDisable Save changesvalidation = required
Phone number format invalidHighlight phone field and disable Save changeserror = invalid_phone
No profile changes detectedKeep Save changes disabledstate = unchanged
Request in progressShow loading statestate = loading
Request blockedDisplay restriction messageHTTP 405

Actions

ScenarioApp BehaviorSDK Output
Profile field updatedUpdate local form stateprofile = updated
Country code selectedUpdate phone country codecountryCode = updated
Save changes selectedSubmit profile updatesProfile update request triggered
Profile update succeedsRefresh profile detailsprofile = saved
Change Password selectedOpen Change Password screenNavigation event
Security–2 step verification selectedOpen MFA setup or management screenNavigation event
Manage my private data selectedOpen personal data controlsNavigation event
Back selectedReturn to Account screenNavigation event

Endpoint Resources

Edit Account

PUT 

v3/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.