Creates a new lead.

Input Fields

  • Lead
    • Salutation (text): Salutation (Mr/Mrs/etc).
    • Title (text): Title (Principal/CFO/CEO).
    • First Name (text): First/Given Name.
    • Last Name (text): Last/Family/Surname of the Lead.
    • Organization Name (text): Organization Name.
    • Phone Number (text): Phone Number.
    • Mobile Phone Number (text): Mobile Number.
    • Fax Number (text): Fax Number
    • Email Address (text): Email Address
    • Website URL (text): Website URL Address.
    • Owner User ID (text): User ID of the Lead Owner.
    • Visible To (text): This field can have one of the following values: ‘Everyone’ (Default), ‘Owner’, ‘Team’, or ‘Individuals’.
    • Responsible User ID (text): Responsible User’s ID.
    • Industry (text): The associated Industry
    • Lead Status ID  (text): Lead Statuses which will be having a value pair of (status and status type).
    • Lead Source ID  (text): Lead Source i.e. web, phone etc.
    • Visible Team ID  (text): If VISIBLE_TO is ‘Team’, then this should be a Team ID, which must be a valid TEAM_ID record locator.
    • Employee Count (text): Employee count for the lead’s organization
    • Lead Rating  (text): Lead’s Rating
    • Lead Description  (text): Lead’s Description
    • Visible User IDs (list of integers): If VISIBLE_TO is ‘Individuals’, then this should be a comma-separated list of User IDs. This field is always empty in the response. Upon successful POST or PUT an anonymous team is created from the list of IDs, and the response will contain a VISIBLE_TEAM_ID.
    • Tags (list of text): Set of Tags attached to the Lead.
  • Address (list of text):
    • Address Type (text): ADDRESS_TYPE must be one of the following values: ‘Postal’, ‘Work’, ‘Primary’, ‘Home’ or ‘Other’. ‘Postal’, ‘Work’ and ‘Primary’ map to the Mailing Address and ‘Home’ and ‘Other’ map to the Other Address.
    • Street (text): Street Number and Name of Address.
    • City (text): City.
    • State (text): State/Province.
    • Postcode (text): Zip or Postal Code.
    • Country (text): Country.
  • Custom Fields1
    • Lead Custom Field _(text): C_ustomizable field for the lead.

Output Fields

  • Lead
    • Lead ID (text): Unique key of the Lead record.
    • Date Created (text): Date the Lead was created.