View as Markdown
ClickFunnels icon

ClickFunnels ACTION

Update or Create Contact

Searches for a contact by email and updates it, or creates a new one if not found. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's ClickFunnels account once, then configure and run Update or Create Contact 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: "clickfunnels-update-create-contact",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    clickfunnels: { authProvisionId: "apn_xxxxxxx" },
    teamId: "Team Id",
    workspaceId: "Workspace 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.

Update or Create Contact inputs
Property Type Description
teamId Team Id string
The unique identification of the team.
Required Dynamic
workspaceId Workspace Id string
The unique identification of the workspace.
Required Dynamic
email Email string
The email address of the contact
Required
firstName First Name string
The contact's first name.
Optional
lastName Last Name string
The contact's last name.
Optional
phoneNumber Phone Number string
The contact's phone number.
Optional
timeZone Time Zone string
The contact's time zone.
Optional
fbUrl FB URL string
The contact's Facebook URL.
Optional
twitterUrl Twitter URL string
The contact's twitter URL.
Optional
instagramUrl Instagram URL string
The contact's instagram URL.
Optional
linkedinUrl Linkedin URL string
The contact's linkedin URL.
Optional
websiteUrl Website URL string
The contact's website URL.
Optional
tagIds Tag Ids string[]
An empty array is ignored here. If you wish to remove all tags for a Contact, use the Update Contact endpoint. A non-empty array overwrites the existing array.
Optional Dynamic
customAttributes Custom Attributes object
Custom attributes are usually added in ClickFunnels to a contact when they submit forms that contain custom contact attributes. Here you can directly create them during contact modification. Custom attributes are provided as key-value pairs: A key that does not exist, will create a new custom contact attribute. A key that already exists, will update the value of an existing custom contact attribute. Empty or null values, will set the custom attribute values to empty strings. A key that has special characters or spaces will be automatically converted to snake_case (For example, 'Favorite Food! 🥑' will be converted to 'favorite_food'). Empty keys will trigger a bad request response. Also, non-object inputs for custom_attributes(e.g. an array or string), it will be ignored. Keys that are default properties on the Contact resource or variations of it will result in an error. E.g., 'first_name', 'First Name', etc. are not valid inputs.
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
clickfunnels-update-create-contact
Version
0.0.2
App
ClickFunnels
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes