LeadInput

Input for creating a new lead

  • firstName
    Type: string
    required

    Lead's first name

  • lastName
    Type: string
    required

    Lead's last name

  • archived
    Type: boolean

    Whether the lead is archived

  • assignedTo
    Type: string

    User assigned to this lead. If not provided, will be automatically assigned using lead rotation if available.

  • branch
    Type: string

    Branch location

  • buyingRole
    Type: string

    Lead's role in buying decisions

  • company
    Type: string

    Company name

  • createdBy
    Type: string

    Email of the user who created the lead. If not provided, will be set to the current user's email.

  • currentPaymentProcessor
    Type: string

    Lead's current payment processor

  • email
    Type: string

    Lead's email address

  • fbclid
    Type: string

    Facebook click identifier captured at lead creation

  • gclid
    Type: string

    Google Ads click identifier captured at lead creation

  • imgSrc
    Type: string

    URL to lead's profile image

  • interestedInSwitching
    Type: boolean

    Whether the lead is interested in switching services

  • jobTitle
    Type: string

    Lead's job title

  • lastContacted
    Type: stringFormat: date-time

    Date and time of last contact with this lead

  • leadSourceId
    Type: integer

    ID of the lead source associated with this lead. Required if the team has lead sources, unless skipTeamAndSourceRequirement=true.

  • location
    Type: string

    Geographic location

  • metaData
    Type: object

    Free-form metadata captured alongside the lead. Recognized keys include fingerprint (browser/device fingerprint).

    • fingerprint
      Type: string

      Optional browser/device fingerprint

  • monthlyTransactionVolume
    Type: integer

    Monthly transaction volume in dollars

  • msclkid
    Type: string

    Microsoft Advertising click identifier captured at lead creation

  • notes
    Type: string

    General notes about the lead

  • numberOfEmployees
    Type: integer

    Number of employees at the lead's company

  • phone
    Type: string

    Lead's phone number

  • position
    Type: string

    Position within company

  • processStage
    Type: string

    Current stage in the sales process

  • productsServicesSold
    Type: string

    Products or services the lead sells

  • source
    Type: string

    Text description of lead source

  • teamId
    Type: integer

    ID of the team associated with this lead. Required if teams exist in the account, unless skipTeamAndSourceRequirement=true.

  • utm_campaign
    Type: string

    UTM campaign parameter captured at lead creation

  • utm_content
    Type: string

    UTM content parameter captured at lead creation

  • utm_medium
    Type: string

    UTM medium parameter captured at lead creation

  • utm_source
    Type: string

    UTM source parameter captured at lead creation

  • utm_term
    Type: string

    UTM term parameter captured at lead creation