View as Markdown
Pipedrive icon

Pipedrive ACTION

Add Lead

Create a new lead in Pipedrive. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Pipedrive account once, then configure and run Add 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: "pipedrive-add-lead",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    pipedrive: { authProvisionId: "apn_xxxxxxx" },
    title: "Title",
    personId: 10,
  },
})

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.

Add Lead inputs
Property Type Description
title Title string
The name of the lead
Required
personId Person ID integer
The ID of a person which this lead will be linked to. If the person does not exist yet, it needs to be created first. This property is required unless organization_id is specified.
Optional Dynamic
organizationId Organization ID integer
The ID of an organization which this lead will be linked to. If the organization does not exist yet, it needs to be created first. This property is required unless person_id is specified.
Optional Dynamic
ownerId User ID integer
The ID of the user which will be the owner of the created lead. If not provided, the user making the request will be used.
Optional Dynamic
leadLabelIds Lead Label IDs string[]
The IDs of the lead labels to associate with the lead
Optional Dynamic
value Value object
Potential value of the lead, e.g. { "amount": 200, "currency": "EUR" }
Optional
expectedCloseDate Expected Close Date string
The date of when the deal which will be created from the lead is expected to be closed. In ISO 8601 format: YYYY-MM-DD.
Optional
visibleTo Visible To string
The visibility of the lead. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups here.
Optional
wasSeen Was Seen boolean
A flag indicating whether the lead was seen by someone in the Pipedrive UI
Optional
note Note string
A note to add to the lead
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
pipedrive-add-lead
Version
0.0.20
App
Pipedrive
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes