Leads

The leads object contains information such as their firstName, lastName, etc.

{
  id: "00000000-0000-0000-0000-000000000000",
  lastName: "Frey (Sample)",
  leadOwner: "Gregg Mojica",
  addresses: [
    {
      country: "United States",
      street1: "4 B Blue Ridge Blvd",
      state: "MI",
      city: "Brighton",
      addressType: "main"
    }
  ],
  phoneNumbers: [
    {
      phoneNumberType: "main",
      phoneNumber: "555-555-5555"
    },
    {
      phoneNumberType: "mobile",
      phoneNumber: "555-555-5555"
    }
  ],
  leadTitle: "Mechanical Systems Engineer",
  firstName: "Theola",
  leadSource: "Cold Call",
  remoteId: "0000000000000000000",
  company: "Dal Tile Corporation",
  emailAddresses: [
    {
      emailAddressType: "main",
      emailAddress: "[email protected]"
    }
  ],
  remoteCreatedAt: "2023-11-19T17:00:17.000Z",
  remoteUpdatedAt: "2023-11-19T17:00:17.000Z",
  remoteDeleted: false,
  createdAt: "2024-02-22T11:17:53.264Z",
  updatedAt: "2024-02-22T13:54:03.445Z"
}

Properties


idString

A string representing the unique identifier of the lead item.


remoteIdString

The ID of the object in the third-party application.


leadOwnerString

The name or identifier of the individual or team responsible for managing the lead.


leadSourceString

The origin or source where the lead was generated, such as 'Website', 'Event', or 'Referral'.


accountString

The name or identifier of the account with which the contact is associated.


leadTitleString

The title or position of the lead within their organization.


companyString

The name of the company or organization that the lead is associated with.


firstNameString

The first name of the lead.


lastNameString

The last name or surname of the lead.


addressesObject[]

An array of address objects related to the lead.


emailAddressesObject[]

An array of email address objects associated with the lead.


phoneNumbersObject[]

An array of phone number objects associated with the lead.


remoteCreatedAtDateTime

The exact date and time when the record was first added or created in the third-party application.


remoteUpdatedAtDateTime

The latest date and time when any modifications or updates were made to the record's details in the third-party application.


remoteDeletedBoolean

Flag to indicate that the record has been deleted in the third-party application.


createdAtDateTime

Date and time the record has been synced into the data cache.


updatedAtDateTime

Date and time the record has been updated in the data cache.


Address Object


addressTypeString

The type of the address (e.g., shipping, billing).


countryString

The country of the address.


cityString

The city of the address.


street1String

The first line of the address.


street2String

The second line of the address.


stateString

The state of the address.


countrySubdivisionString

The country subdivision of the address.


postalCodeString

The postal/zip code of the address


Phone Number Properties


phoneNumberTypeString

The type of the phone number (e.g., primary, secondary).


phoneNumberString

The phone number.


Email Address Properties


emailAddressTypeString

The type of the email address (e.g., main, secondary).


emailAddressString

The email address.