View as Markdown
HelloLeads icon

HelloLeads ACTION

Create Lead

Adds a new lead into the HelloLeads system. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's HelloLeads account once, then configure and run Create Lead from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "helloleads-create-lead",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    helloleads: { authProvisionId: "apn_xxxxxxx" },
    listKey: "List Key",
    firstName: "First Name",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Lead inputs
Property Type Description
listKey List Key string
The key of the list.
Required Dynamic
firstName First Name string
First name of the lead.
Required
lastName Last Name string
Last name of the lead.
Optional
designation Designation string
Designation of the lead.
Optional
company Company string
Lead organization name.
Optional
email Email string
Primary email address of the lead.
Optional
phone Phone integer
Work phone number of the lead.
Optional
mobile Mobile integer
Mobile phone number of the lead.
Optional
fax Fax integer
Fax number of the lead.
Optional
addressLine1 Address Line 1 string
Address line1 of the lead.
Optional
addressLine2 Address Line 2 string
Address line2 of the lead.
Optional
city City string
City that the lead belongs to.
Optional
state State string
State that the lead belongs to.
Optional
postalCode Postal Code string
Zip code of the region that the lead belongs to.
Optional
country Country string
Country that the lead belongs to.
Optional
website Website string
Website reference of the lead.
Optional
notes Notes string
Specify any other details about the lead.
Optional
interests Interests string[]
A list of Product/Interest which offered by you is interested to Lead. (Don't use special characters).
Optional
category Category string
Customer group of a Lead. (Don't use special characters).
Optional
tags Tags string[]
Short tags (Tagging words) on lead. (Do not use special characters).
Optional
mobileCode Mobile Code string
Mobile country code.
Optional
dealSize Deal Size string
Deal value of the business.
Optional
potential Potential string
How potential is the customer. By default, it will be Low.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
helloleads-create-lead
Version
0.0.2
App
HelloLeads
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes