Add Client

Introduction

This guide explains how to use the Add Client page in My Home Plan to create new client records or bulk‑import clients from an Excel file.

From the left sidebar, click Clients.
Click Add Client (or navigate to the add screen where the Add / Import tabs are available).

Breadcrumbs: Shows the current location as Add Client.
Tabs:
- Add: Open the client form to add a single client.
- Import: Upload an Excel sheet to import multiple clients at once.
Company Context: Data is tied to the currently selected company. If no company is selected, the page will prompt you to select one.

Form Fields:
- Full Name (required)
- Email (required; validated)
- Address (required)
- Country (picker with country calling code)
- Phone Number (required; combined with country code into E.164 format like +9715XXXXXXXX)
- Assigned Agents (multi‑select)
Behavior:
- Validation:
  - Name must be at least 2 characters.
  - Email must be valid.
  - A Company must be selected unless you’re editing an existing client.
- Phone Formatting:
  - The selected Country determines the calling code.
  - The Phone Number field captures the national number; the system saves the full number (e.g., +20 + 1XXXXXXXXX).
- Editing Mode:
  - If you open the form with an existing client, only changed fields are sent when saving.
- Assigned Agents:
  - Choose one or more agents from the searchable multi‑select.
Actions:
- Save: Creates or updates the client.
- Close (when used as a modal): Closes the modal without saving.
Feedback:
- Error Banner (red): Displays API validation or server errors.
- Loading State: Shows “Saving...” on the button while submitting.

Overview: Import multiple clients using a simple Excel file.
Actions:
- Download Example: Downloads an empty template (emptySheet.xlsx) with headers:
  - Name, Email, Phone, Source
- Choose File: Select your completed Excel file.
- Save Data: Starts uploading all rows to the server.
- Reset: Clears the loaded data and statuses.
Table Preview:
- Shows the parsed rows with columns Name, Email, Phone, Source, and Status.
- The Status column updates after saving:
  - Success (green) for successful rows.
  - Error (red) with the server’s message for failed rows.
Progress Indicator:
- Shows X of Y Finished while requests are processed.
Company Requirement:
- If no company is selected, the tab shows “Please select a company”.

Add a Single Client
- Go to Add tab.
- Fill Full Name, Email, Address, select Country, enter Phone Number, and (optionally) assign agents.
- Click Save.
Assign Agents to a Client
- In Assigned Agents, search and select one or more agents.
- Click Save.
Import Multiple Clients
- Go to Import tab.
- Click Download Example and prepare your Excel file with the required headers.
- Click Choose File and select your file.
- Click Save Data and monitor the Status column.
Reset the Import List
- Click Reset to clear the current dataset and statuses.

“Please Select a Company” Message
- Choose a company from the app header/context selector, then return to Add Client.
Validation Errors (red banner)
- Ensure the name has at least 2 characters and the email is valid.
- Confirm that Address, Country, and Phone Number are filled.
Phone Number Not Accepted
- Verify the Country picker matches the number’s country.
- Enter only the national number in the Phone Number field (the system adds the calling code automatically).
Import Fails for Some Rows
- Open the Status column to see the API error message per row.
- Fix the data in your file and re‑upload, or correct individual clients manually in the Add tab.
No Agents Listed
- Ensure users are created in the system; the list populates automatically from the Users endpoint.

Reach out via: