View as Markdown
Instantly icon

Instantly ACTION

Add Leads to Campaign

Adds a lead or leads to a campaign for tracking or further actions. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Instantly account once, then configure and run Add Leads to Campaign 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: "instantly-add-lead-campaign",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    instantly: { authProvisionId: "apn_xxxxxxx" },
    leadIds: ["Lead IDs"],
    campaignId: "Campaign 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.

Add Leads to Campaign inputs
Property Type Description
leadIds Lead IDs string[]
The array of lead IDs to include
Required Dynamic
campaignId Campaign ID string
The ID of the campaign
Required Dynamic
skipIfInCampaign Skip if in Campaign boolean
Skip lead if it exists in the campaign
Optional
waitForCompletion Wait for Completion boolean
Set to true to poll the API in 3-second intervals until the background job is completed
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
instantly-add-lead-campaign
Version
0.0.4
App
Instantly
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes