View as Markdown
Agiliron icon

Agiliron ACTION

Create Lead

Establishes a new lead within Agiliron. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Agiliron 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: "agiliron-create-lead",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    agiliron: { authProvisionId: "apn_xxxxxxx" },
    lastname: "Last Name",
    company: "Company",
  },
})

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
lastname Last Name string
The last name of the lead.
Required
company Company string
The company of the lead
Required
salutation Salutation string
The salutation of the lead
Optional
firstName First Name string
The first name of the lead
Optional
designation Designation string
The designation of the lead
Optional
phone Phone string
The phone number of the lead
Optional
mobile Mobile string
The mobile number of the lead
Optional
fax Fax string
The fax number of the lead
Optional
email Email string
The email address of the lead
Optional
website Website string
The website of the lead. Without http:// or https://
Optional
industry Industry string
The industry of the lead
Optional
sicCode SIC Code string
The SIC code of the lead
Optional
annualRevenue Annual Revenue string
The annual revenue of the lead. (US Dollar : $)
Optional
numberOfEmployees Number of Employees string
The number of employees of the lead
Optional
contactType Contact Type string
The contact type of the lead
Optional
leadSource Lead Source string
The lead source of the lead
Optional
leadStatus Lead Status string
The lead status of the lead
Optional
rating Rating string
The rating of the lead
Optional
emailOptOut Email Opt Out string
The email opt-out status of the lead
Optional
yahooId Yahoo ID string
The Yahoo ID of the lead
Optional
street Street string
The street address of the lead
Optional
city City string
The city of the lead
Optional
state State string
The state of the lead
Optional
zip Zip string
The zip code of the lead
Optional
country Country string
The country of the lead
Optional
description Description string
The description of the lead
Optional
assignedTo Assigned To string
The user to whom the lead is assigned
Optional
assignedGroupName Assigned Group Name string
The group to which the contact or lead is assigned
Optional
customFields Custom Fields object
An object of custom fields for the lead. Format: {customFieldName01: "Value 01"}
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
agiliron-create-lead
Version
0.0.2
App
Agiliron
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes