Referrals

What it is

Manage referral contacts and their contact information including name, email, phone number, and optional WhatsApp number.

Who it's for

Workspace Owner Staff

Access & Scope

Property	Value
Module	referrals
Personas	workspace-owner, staff
Scope	Workspace-level
UI Location	Dashboard > People Management > Referrals

| Status | active |

UI Location

Dashboard > People Management > Referrals

How it works

The Referrals feature allows workspaces to manage a list of referral contacts. Here's how it works:

1. Referral List View: Displays all referrals in a paginated table format showing:

   • Referral name
   • Email address
   • Phone number with country code
   • WhatsApp number (if available)
   • Created date
   • Quick actions (edit, delete)

2. Search Functionality:

   • Real-time search by name, email, phone, or WhatsApp number
   • Search is case-insensitive and matches partial text
   • Works across all contact fields

3. Referral Management:

   • Create new referrals with name, email, country code, phone, and optional WhatsApp number
   • Edit existing referral information
   • Delete referrals (with confirmation)
   • Each referral email must be unique within a workspace

4. Pagination:

   • Default page size: 20 items
   • Configurable limit (1-100 items per page)
   • Navigation controls for moving between pages

Features

• Contact Management: Store and manage referral contact information
• Search: Quick search across all contact fields
• Email Uniqueness: Automatic validation to ensure unique emails per workspace
• Pagination: Efficient handling of large referral lists
• WhatsApp Integration: Optional WhatsApp number field for messaging

Integration with People Management

Referrals is part of the People Management section, which includes:

• Staff Directory: Manage staff members
• Clients: Manage client directory
• Referrals: Manage referral contacts

The People Management section uses tabs to switch between these different views, and the available tabs are controlled by workspace menu configuration.

Menu Configuration

Referrals can be enabled or disabled for a workspace through the admin menu override settings. When enabled, the Referrals tab appears in the People Management section.

API Access

All referral operations are available through the Referrals API endpoints.