Leads Controller

The Leads Controller provides comprehensive lead management capabilities including lead creation, tracking, pipeline management, conversion tracking, and analytics for the VChata platform.

Base Path

/leads

Overview

This controller enables complete lead lifecycle management:

🎯 Lead Creation - Create leads from contacts or social interactions
📊 Pipeline Management - Move leads through customizable stages
🔄 Conversion Tracking - Track conversions and attribution
📈 Analytics - Comprehensive lead analytics and reporting
🎭 Activity Tracking - Log and track lead interactions
🔗 Social Integration - Connect leads to social media interactions

Authentication & Authorization

🔐 All endpoints require valid JWT authentication token
🏢 All operations are scoped to the user’s current organization
👥 Organization membership required for all operations

Lead Management

Create Lead

POST /leads/org_abc123
Authorization: Bearer <token>
Content-Type: application/json

{
  "contactId": "contact_456",
  "pipelineId": "pipeline_789",
  "source": "website",
  "value": 1000,
  "notes": "Interested in premium package",
  "utmSource": "google",
  "utmMedium": "cpc",
  "utmCampaign": "premium_ads"
}

{
  "success": true,
  "lead": {
    "id": "lead_123",
    "contactId": "contact_456",
    "pipelineId": "pipeline_789",
    "stageId": "clxyz123456789abcdef",
    "source": "website",
    "value": 1000,
    "status": "NEW",
    "notes": "Interested in premium package",
    "utmSource": "google",
    "utmMedium": "cpc",
    "utmCampaign": "premium_ads",
    "createdAt": "2024-01-15T10:30:00Z"
  },
  "message": "Lead created successfully"
}

Description: Creates a new lead for an existing contact in the system.

body

object

Show Request Body

contactId

string

required

ID of the existing contact

pipelineId

string

required

ID of the pipeline to add the lead to

source

string

required

Lead source (website, social, referral, etc.)

value

number

Estimated lead value in cents

notes

string

Additional notes about the lead

utmSource

string

UTM source parameter

utmMedium

string

UTM medium parameter

utmCampaign

string

UTM campaign parameter

Create Lead with Contact

POST /leads/org_abc123/with-contact
Authorization: Bearer <token>
Content-Type: application/json

{
  "contact": {
    "name": "John Doe",
    "email": "john@example.com",
    "phone": "+1234567890",
    "company": "Acme Corp"
  },
  "pipelineId": "pipeline_789",
  "source": "website",
  "value": 1000,
  "notes": "New lead from contact form"
}

{
  "success": true,
  "lead": {
    "id": "lead_123",
    "contactId": "contact_456",
    "pipelineId": "pipeline_789",
    "stageId": "clxyz123456789abcdef",
    "source": "website",
    "value": 1000,
    "status": "NEW",
    "createdAt": "2024-01-15T10:30:00Z"
  },
  "contact": {
    "id": "contact_456",
    "name": "John Doe",
    "email": "john@example.com",
    "phone": "+1234567890",
    "company": "Acme Corp",
    "createdAt": "2024-01-15T10:30:00Z"
  },
  "message": "Lead and contact created successfully"
}

Description: Creates both a new contact and lead in a single request.

body

object

Show Request Body

contact

object

required

name

string

required

Contact’s full name

string

required

Contact’s email address

phone

string

Contact’s phone number

company

string

Contact’s company name

pipelineId

string

required

ID of the pipeline to add the lead to

source

string

required

Lead source (website, social, referral, etc.)

value

number

Estimated lead value in cents

notes

string

Additional notes about the lead

Get All Leads

GET /leads/org_abc123?pipelineId=pipeline_789&status=QUALIFIED&page=1&limit=10
Authorization: Bearer <token>

{
  "success": true,
  "leads": [
    {
      "id": "lead_123",
      "contactId": "contact_456",
      "pipelineId": "pipeline_789",
      "stageId": "clxyz987654321fedcba",
      "source": "website",
      "value": 1500,
      "status": "QUALIFIED",
      "assignedToId": "user_789",
      "contact": {
        "id": "contact_456",
        "name": "John Doe",
        "email": "john@example.com",
        "phone": "+1234567890",
        "company": "Acme Corp"
      },
      "pipeline": {
        "id": "pipeline_789",
        "name": "Sales Pipeline",
        "stages": [
          {
            "id": "clxyz987654321fedcba",
            "name": "Qualified",
            "order": 2
          }
        ]
      },
      "socialAccount": {
        "id": "social_123",
        "platform": "FACEBOOK",
        "platformId": "123456789",
        "name": "Acme Corp Facebook"
      },
      "contentPost": {
        "id": "post_456",
        "platformPostId": "987654321",
        "content": "Check out our new product!",
        "url": "https://facebook.com/posts/987654321"
      },
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-20T15:30:00Z"
    }
  ],
  "pagination": {
    "total": 1,
    "page": 1,
    "limit": 10,
    "hasMore": false
  },
  "message": "Leads retrieved successfully"
}

Description: Retrieves all leads for the organization with optional filtering and pagination.

query

object

Show Query Parameters

pipelineId

string

Filter by pipeline ID

status

string

Filter by lead status (NEW, QUALIFIED, CONTACTED, CONVERTED, LOST)

assignedToId

string

Filter by assigned user ID

stageId

string

Filter by stage ID

source

string

Filter by lead source

Filter by social account ID

contentPostId

string

Filter by content post ID

page

number

Page number for pagination (default: 1)

limit

number

Number of items per page (default: 10, max: 100)

Get Lead Details

GET /leads/org_abc123/lead_123
Authorization: Bearer <token>

{
  "success": true,
  "lead": {
    "id": "lead_123",
    "contactId": "contact_456",
    "pipelineId": "pipeline_789",
    "stageId": "clxyz987654321fedcba",
    "source": "website",
    "value": 1500,
    "status": "QUALIFIED",
    "assignedToId": "user_789",
    "notes": "Interested in premium package",
    "utmSource": "google",
    "utmMedium": "cpc",
    "utmCampaign": "premium_ads",
    "converted": false,
    "convertedAt": null,
    "contact": {
      "id": "contact_456",
      "name": "John Doe",
      "email": "john@example.com",
      "phone": "+1234567890",
      "company": "Acme Corp"
    },
    "pipeline": {
      "id": "pipeline_789",
      "name": "Sales Pipeline"
    },
    "stage": {
      "id": "clxyz987654321fedcba",
      "name": "Qualified",
      "order": 2
    },
    "activities": [
      {
        "id": "activity_123",
        "type": "EMAIL_SENT",
        "description": "Follow-up email sent",
        "createdAt": "2024-01-16T10:00:00Z"
      }
    ],
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-20T15:30:00Z"
  },
  "message": "Lead retrieved successfully"
}

Description: Retrieves detailed information about a specific lead including activities and related data.

Update Lead

PATCH /leads/org_abc123/lead_123
Authorization: Bearer <token>
Content-Type: application/json

{
  "value": 2000,
  "status": "CONTACTED",
  "assignedToId": "user_456",
  "notes": "Updated notes after phone call"
}

{
  "success": true,
  "lead": {
    "id": "lead_123",
    "value": 2000,
    "status": "CONTACTED",
    "assignedToId": "user_456",
    "notes": "Updated notes after phone call",
    "updatedAt": "2024-01-20T16:00:00Z"
  },
  "message": "Lead updated successfully"
}

Description: Updates lead information including status, value, assignment, and notes.

Delete Lead

DELETE /leads/org_abc123/lead_123
Authorization: Bearer <token>

{
  "success": true,
  "message": "Lead deleted successfully"
}

Description: Permanently deletes a lead from the system.

Lead Activities

Add Lead Activity

POST /leads/org_abc123/lead_123/activities
Authorization: Bearer <token>
Content-Type: application/json

{
  "type": "EMAIL_SENT",
  "description": "Follow-up email sent regarding pricing",
  "metadata": {
    "emailSubject": "Re: Your inquiry about our services",
    "emailId": "email_789"
  }
}

{
  "success": true,
  "activity": {
    "id": "activity_123",
    "leadId": "lead_123",
    "type": "EMAIL_SENT",
    "description": "Follow-up email sent regarding pricing",
    "metadata": {
      "emailSubject": "Re: Your inquiry about our services",
      "emailId": "email_789"
    },
    "createdAt": "2024-01-20T16:00:00Z"
  },
  "message": "Activity added successfully"
}

Description: Adds an activity record to track interactions with the lead.

body

object

Show Request Body

type

string

required

Activity type (EMAIL_SENT, PHONE_CALL, MEETING, NOTE, etc.)

description

string

required

Description of the activity

metadata

object

Additional metadata for the activity

Pipeline Management

Move Lead to Stage

POST /leads/org_abc123/lead_123/move-stage
Authorization: Bearer <token>
Content-Type: application/json

{
  "stageId": "clxyz111222333444555",
  "notes": "Lead moved to qualified stage after initial contact"
}

{
  "success": true,
  "lead": {
    "id": "lead_123",
    "stageId": "clxyz111222333444555",
    "status": "QUALIFIED",
    "updatedAt": "2024-01-20T16:00:00Z"
  },
  "message": "Lead moved to new stage successfully"
}

Description: Moves a lead to a different stage in the pipeline.

body

object

Show Request Body

stageId

string

required

ID of the new stage to move the lead to

notes

string

Optional notes about the stage change

Conversion Management

Convert Conversation to Lead

POST /leads/org_abc123/convert-conversation
Authorization: Bearer <token>
Content-Type: application/json

{
  "conversationId": "conv_123",
  "pipelineId": "pipeline_789",
  "source": "social_media",
  "value": 1500,
  "notes": "Converted from Instagram DM conversation"
}

{
  "success": true,
  "lead": {
    "id": "lead_456",
    "contactId": "contact_789",
    "pipelineId": "pipeline_789",
    "source": "social_media",
    "value": 1500,
    "status": "NEW",
    "createdAt": "2024-01-20T16:00:00Z"
  },
  "contact": {
    "id": "contact_789",
    "name": "Jane Smith",
    "email": "jane@example.com",
    "phone": "+1987654321"
  },
  "message": "Conversation converted to lead successfully"
}

Description: Converts a conversation (from social media, chat, etc.) into a lead.

body

object

Show Request Body

conversationId

string

required

ID of the conversation to convert

pipelineId

string

required

ID of the pipeline to add the lead to

source

string

required

Lead source (social_media, chat, email, etc.)

value

number

Estimated lead value in cents

notes

string

Additional notes about the conversion

Analytics

Get Lead Statistics

GET /leads/org_abc123/stats
Authorization: Bearer <token>

{
  "success": true,
  "stats": {
    "totalLeads": 150,
    "newLeads": 25,
    "qualifiedLeads": 45,
    "contactedLeads": 30,
    "convertedLeads": 15,
    "lostLeads": 5,
    "conversionRate": 10.0,
    "averageValue": 1250,
    "totalValue": 187500
  },
  "message": "Lead statistics retrieved successfully"
}

Description: Retrieves comprehensive lead statistics and metrics.

Get Source Analytics

GET /leads/org_abc123/analytics/sources
Authorization: Bearer <token>

{
  "success": true,
  "sources": [
    {
      "source": "website",
      "count": 75,
      "conversionRate": 12.0,
      "averageValue": 1100,
      "totalValue": 82500
    },
    {
      "source": "social_media",
      "count": 45,
      "conversionRate": 8.9,
      "averageValue": 1400,
      "totalValue": 63000
    }
  ],
  "message": "Source analytics retrieved successfully"
}

Description: Retrieves analytics broken down by lead source.

Get Campaign Analytics

GET /leads/org_abc123/analytics/campaigns
Authorization: Bearer <token>

{
  "success": true,
  "campaigns": [
    {
      "campaignId": "campaign_123",
      "campaignName": "Summer Sale 2024",
      "leadCount": 30,
      "conversionRate": 15.0,
      "averageValue": 1800,
      "totalValue": 54000
    }
  ],
  "message": "Campaign analytics retrieved successfully"
}

Description: Retrieves analytics broken down by campaign.

Get Pipeline Analytics

GET /leads/org_abc123/analytics/pipeline
Authorization: Bearer <token>

{
  "success": true,
  "pipeline": {
    "id": "pipeline_789",
    "name": "Sales Pipeline",
    "stages": [
      {
        "id": "stage_1",
        "name": "New",
        "leadCount": 25,
        "averageTimeInStage": 2.5
      },
      {
        "id": "stage_2",
        "name": "Qualified",
        "leadCount": 45,
        "averageTimeInStage": 7.2
      },
      {
        "id": "stage_3",
        "name": "Contacted",
        "leadCount": 30,
        "averageTimeInStage": 14.1
      }
    ],
    "overallConversionRate": 10.0,
    "averageTimeToConvert": 23.8
  },
  "message": "Pipeline analytics retrieved successfully"
}

Description: Retrieves detailed pipeline analytics including stage performance and conversion metrics.

Error Responses

Common Errors

{
  "success": false,
  "statusCode": 404,
  "message": "Lead not found or you don't have access",
  "error": "Not Found"
}

{
  "success": false,
  "statusCode": 400,
  "message": [
    "pipelineId is required",
    "contactId must be a valid UUID"
  ],
  "error": "Bad Request"
}

{
  "success": false,
  "statusCode": 409,
  "message": "Lead already exists for this contact and pipeline",
  "error": "Conflict"
}

Lead Status Values

NEW - Recently created lead
QUALIFIED - Lead has been qualified as a potential customer
CONTACTED - Initial contact has been made
CONVERTED - Lead has been converted to a customer
LOST - Lead is no longer viable

Integration Features

🔗 Social Media Integration - Connect leads to social media interactions
📊 UTM Tracking - Track marketing campaign effectiveness
🎯 Attribution - Track lead sources and conversion paths
📈 Real-time Analytics - Live updates on lead performance
🔄 Pipeline Automation - Automatic stage progression rules
📧 Activity Tracking - Complete interaction history
🎭 Custom Fields - Extensible lead data structure

Getting Started

Authentication

Core Services

Content & Social

AI & Automation

Analytics & Insights

Communication

Utilities

Services

Leads Controller

Leads Controller

Base Path

Overview

Authentication & Authorization

Lead Management

Create Lead

Create Lead with Contact

Get All Leads

Get Lead Details

Update Lead

Delete Lead

Lead Activities

Add Lead Activity

Pipeline Management

Move Lead to Stage

Conversion Management

Convert Conversation to Lead

Analytics

Get Lead Statistics

Get Source Analytics

Get Campaign Analytics

Get Pipeline Analytics

Error Responses

Common Errors

Lead Status Values

Integration Features

Getting Started

Authentication

Core Services

Content & Social

AI & Automation

Analytics & Insights

Communication

Utilities

Services

Documentation Index

​Leads Controller

​Base Path

​Overview

​Authentication & Authorization

​Lead Management

​Create Lead

​Create Lead with Contact

​Get All Leads

​Get Lead Details

​Update Lead

​Delete Lead

​Lead Activities

​Add Lead Activity

​Pipeline Management

​Move Lead to Stage

​Conversion Management

​Convert Conversation to Lead

​Analytics

​Get Lead Statistics

​Get Source Analytics

​Get Campaign Analytics

​Get Pipeline Analytics

​Error Responses

​Common Errors

​Lead Status Values

​Integration Features

Leads Controller

Base Path

Overview

Authentication & Authorization

Lead Management

Create Lead

Create Lead with Contact

Get All Leads

Get Lead Details

Update Lead

Delete Lead

Lead Activities

Add Lead Activity

Pipeline Management

Move Lead to Stage

Conversion Management

Convert Conversation to Lead

Analytics

Get Lead Statistics

Get Source Analytics

Get Campaign Analytics

Get Pipeline Analytics

Error Responses

Common Errors

Lead Status Values

Integration Features