View as Markdown
Nutshell icon

Nutshell ACTION

Create Lead

Create a new lead in Nutshell. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Nutshell 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: "nutshell-create-lead",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    nutshell: { authProvisionId: "apn_xxxxxxx" },
    description: "Description",
    companyId: "Company ID",
  },
})

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
description Description string
Lead description / title.
Optional
companyId Company ID string
The company (account) ID.
Optional Dynamic
contactId Contact ID string
The contact ID.
Optional Dynamic
value Value string
Manual lead value as a string amount (maps to leads/0/manualValue).
Optional
customFields Custom Fields object
Custom field name->value pairs, e.g. {"Deal source":"Referral"}.
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
nutshell-create-lead
Version
1.0.1
App
Nutshell
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes