Merge · Schema

LeadRequest

# 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
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
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.
lead_url	stringnull	The lead's URL in the remote system.
integration_params	objectnull
linked_account_params	objectnull
remote_fields	array

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/LeadRequest",
  "title": "LeadRequest",
  "type": "object",
  "properties": {
    "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/AddressRequest"
      }
    },
    "email_addresses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EmailAddressRequest"
      }
    },
    "phone_numbers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PhoneNumberRequest"
      }
    },
    "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."
    },
    "lead_url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "The lead's URL in the remote system."
    },
    "integration_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    },
    "linked_account_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    },
    "remote_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/RemoteFieldRequest"
      }
    }
  },
  "description": "# The Lead Object\n### Description\nThe `Lead` object is used to represent an individual who is a potential customer.\n### Usage Example\nTODO"
}