🗒️Lead Request Object

Lead Record Fields

This section outlines the fields available for creating or updating a lead in the ClosingDealz CRM through the API. Each field is described with its expected data type and whether it is required or optional.

Fields

  • company (Optional, string): The name of the company associated with the lead.

  • contactPerson (Optional, string): The name of the primary contact person for the lead.

  • jobTitle (Optional, string): The job title of the contact person.

  • industry (Optional, string): The industry sector the lead's company operates in.

  • employeeCount (Optional, integer): The number of employees at the lead's company. Defaults to 1 if not provided.

  • website (Optional, string): The URL of the lead's company website.

  • linkedIn (Optional, string): The LinkedIn profile URL for the company or contact person.

  • twitter (Optional, string): The Twitter handle of the company or contact person.

  • facebook (Optional, string): The Facebook page URL of the company.

  • email (Optional, string): The primary email address of the contact person.

  • email2 (Optional, string): A secondary email address for the contact person.

  • phoneNumber (Optional, string): The contact phone number for the lead.

  • address (Optional, string): The physical address of the company.

  • notes (Optional, string): Any relevant notes or additional information about the lead.

  • timeZone (Optional, string): The time zone of the lead's location.

  • language (Optional, string): The primary language spoken by the lead.

  • date (Optional, datetime): The date the lead was created or captured. Defaults to the current UTC date and time if not specified.

Example JSON Payload for Creating or Updating a Lead

{
  "company": "Acme Corp",
  "contactPerson": "John Doe",
  "jobTitle": "Chief Technology Officer",
  "industry": "Technology",
  "employeeCount": 100,
  "website": "https://www.acmecorp.com",
  "linkedIn": "https://www.linkedin.com/company/acmecorp",
  "twitter": "@acmecorp",
  "facebook": "https://www.facebook.com/acmecorp",
  "email": "jdoe@acmecorp.com",
  "email2": "contact@acmecorp.com",
  "phoneNumber": "+1234567890",
  "address": "123 Acme Way, Tech City, TC 12345",
  "notes": "Met at TechCon 2024. Interested in enterprise solutions.",
  "timeZone": "America/New_York",
  "language": "English",
  "date": "2024-03-14T12:34:56Z"
}

Last updated