Merge · Schema

Lead

# The Lead Object ### Description The `Lead` object is used to represent an individual who is a potential customer. ### Usage Example TODO

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name	Type	Description
id	string
remote_id	stringnull	The third-party API ID of the matching object.
created_at	string	The datetime that this object was created by Merge.
modified_at	string	The datetime that this object was modified by Merge.
owner	stringnull	The lead's owner.
lead_source	stringnull	The lead's source.
title	stringnull	The lead's title.
company	stringnull	The lead's company.
first_name	stringnull	The lead's first name.
last_name	stringnull	The lead's last name.
addresses	array
email_addresses	array
phone_numbers	array
remote_updated_at	stringnull	When the third party's lead was updated.
remote_created_at	stringnull	When the third party's lead was created.
converted_date	stringnull	When the lead was converted.
converted_contact	stringnull	The contact of the converted lead.
converted_account	stringnull	The account of the converted lead.
status	object	The lead's status.
lead_url	stringnull	The lead's URL in the remote system.
remote_was_deleted	boolean	Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited cove
field_mappings	object
remote_data	arraynull
remote_fields	array

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Lead",
  "title": "Lead",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "remote_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The third-party API ID of the matching object."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was created by Merge."
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was modified by Merge."
    },
    "owner": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The lead's owner."
    },
    "lead_source": {
      "type": [
        "string",
        "null"
      ],
      "description": "The lead's source."
    },
    "title": {
      "type": [
        "string",
        "null"
      ],
      "description": "The lead's title."
    },
    "company": {
      "type": [
        "string",
        "null"
      ],
      "description": "The lead's company."
    },
    "first_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "The lead's first name."
    },
    "last_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "The lead's last name."
    },
    "addresses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Address"
      }
    },
    "email_addresses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EmailAddress"
      }
    },
    "phone_numbers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PhoneNumber"
      }
    },
    "remote_updated_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the third party's lead was updated."
    },
    "remote_created_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the third party's lead was created."
    },
    "converted_date": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the lead was converted."
    },
    "converted_contact": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The contact of the converted lead."
    },
    "converted_account": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The account of the converted lead."
    },
    "status": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/LeadStatusEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The lead's status."
    },
    "lead_url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "The lead's URL in the remote system."
    },
    "remote_was_deleted": {
      "type": "boolean",
      "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)."
    },
    "field_mappings": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/LeadFieldMappings"
        },
        {
          "type": "null"
        }
      ]
    },
    "remote_data": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/components/schemas/RemoteData"
      }
    },
    "remote_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/RemoteField"
      }
    }
  },
  "description": "# The Lead Object\n### Description\nThe `Lead` object is used to represent an individual who is a potential customer.\n### Usage Example\nTODO"
}