View as Markdown
KickoffLabs icon

KickoffLabs ACTION

Create or Update Lead

Adds a new lead or modifies an existing lead on your campaign. See the documentation.
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's KickoffLabs account once, then configure and run Create or Update 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: "kickofflabs-create-or-update-lead",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    kickofflabs: { authProvisionId: "apn_xxxxxxx" },
    email: "Email",
    phoneNumber: "Phone Number",
  },
})

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 or Update Lead inputs
Property Type Description
email Email string
Email address of the lead.
Optional
phoneNumber Phone Number string
Phone number of the lead.
Optional
ip IP Address string
By default, we use the IP address of the request. This is great if your are using ajax to make the request. However, if you are making the request on the server, you may want to include user’s ip address.
Optional
url URL string
The URL which the lead signed up on.
Optional
ref Referrer URL string
The referrer url the lead came from.
Optional
userAgent User Agent string
The user agent of the lead.
Optional
source Source string
This will default to API, but you can change it to something unique. This is helpful if you are sending leads in from various sources. In additional, if source is API, we will not perform duplicate IP address checks.
Optional
customFields Custom Fields object
Any additional parameters you include when signing up a lead will be captured as custom fields.
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
kickofflabs-create-or-update-lead
Version
0.0.2
App
KickoffLabs
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes