• Endpoint: /api/leads

• Method: POST

• Description: Capture a new lead by providing relevant information such as name, email, and source.

• Request Parameters:

  • name (string): The name of the lead.

  • email (string): The email address of the lead.

  • source (string): The source from which the lead was captured (e.g., website, email campaign).

Example Request

{
  "name": "John Doe",
  "email": "john@example.com",
  "source": "Website Form"
}

Example Response

{
  "id": "123456789",
  "name": "John Doe",
  "email": "john@example.com",
  "source": "Website Form",
  "timestamp": "2024-04-08T12:00:00Z"
}

• Endpoint: /api/follow-up

• Method: POST

• Description: Send a follow-up email to a lead.

• Request Parameters:

  • lead_id (string): The ID of the lead to whom the follow-up email will be sent.

  • subject (string): The subject of the email.

  • body (string): The body content of the email.

Example Request

{
  "lead_id": "123456789",
  "subject": "Follow-up Email",
  "body": "Hi John, thank you for your interest in our product. Please let me know if you have any questions."
}

Example Response

{
  "message": "Follow-up email sent successfully to lead with ID: 123456789"
}

• Endpoint: /api/leads/{lead_id}

• Method: PUT

• Description: Update the information of a specific lead in CleverApp's database.

• Request Parameters:

  • lead_id (string, required): The unique identifier of the lead whose information will be updated.

  • name (string): The updated name of the lead.

  • email (string): The updated email address of the lead.

  • phone (string): The updated phone number of the lead.

  • status (string): The updated status of the lead (e.g., "Qualified", "Contacted").

Example Request

{
  "name": "Jane Smith",
  "email": "jane@example.com",
  "phone": "+1234567890",
  "status": "Qualified"
}

Example Response

{
  "id": "123456789",
  "name": "Jane Smith",
  "email": "jane@example.com",
  "phone": "+1234567890",
  "status": "Qualified",
  "timestamp": "2024-04-08T12:00:00Z"
}