Skip to main content
GuidesAPI Reference

Create Lead

POST 
/crm/leads

Create lead

Request​

Query Parameters

    credentialId stringrequired

    The ID of the credential.

Header Parameters

    Authorization stringrequired

    Default value: bearer YOUR_API_KEY

Body

    lastName stringrequired

    Filter contacts by the exact last name.

    firstName string

    Filter contacts by the exact first name.

    leadOwner string

    Filter leads by the exact name of the lead owner.

    leadSource string

    Filter leads by their exact source (e.g., inbound, outbound, referral).

    leadTitle string

    Filter leads by their exact title or job role.

    company stringrequired

    Filter leads by the exact name of the associated company.

    addresses

    object[]

    An array of address objects related to the lead.

  • Array [

    • addressType string

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

    street1 string

    The first line of the address.

    street2 string

    The second line of the address.

    city string

    The city of the address.

    state string

    The state of the address.

    countrySubdivision string

    The country subdivision of the address.

    country string

    The country of the address.

    postalCode string

    The postal/zip code of the address.

  • ]

    • emailAddresses

    object[]

    An array of email address objects associated with the lead.

  • Array [

    • emailAddressType string

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

    emailAddress string

    The email address.

  • ]

    • phoneNumbers

    object[]

    An array of phone number objects associated with the lead.

  • Array [

    • phoneNumberType string

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

    phoneNumber string

    The phone number.

  • ]

    • remoteFields json

    An object containing remote fields that are not supported by the common model. The keys are the names of the fields of the corresponding resource in the remote app, and the values can be strings, numbers, arrays or objects.

Responses​

200

Schema

    lead

    object

    remoteId string
    leadOwner string
    leadSource string
    leadTitle string
    company string
    firstName string
    lastName string

    addresses

    object[]

  • Array [

    • country string
    street1 string
    state string
    city string
    addressType string

  • ]

    • emailAddresses

    object[]

  • Array [

    • emailAddressType string
    emailAddress string

  • ]

    • phoneNumbers

    object[]

  • Array [

    • phoneNumberType string
    phoneNumber string

  • ]

    • id string
    remoteCreatedAt string
    remoteUpdatedAt string
    remoteDeleted boolean

    Default value: true

    createdAt string
    updatedAt string
Loading...