View as Markdown
HighLevel icon

HighLevel ACTION

Create Contact

Creates a new contact on HighLevel. See the documentation
  • Action
  • Writes data
  • Destructive
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's HighLevel account once, then configure and run 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: "highlevel_oauth-create-contact",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    highlevel_oauth: { authProvisionId: "apn_xxxxxxx" },
    locationId: "Location ID",
    name: "Name",
  },
})

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 Contact inputs
Property Type Description
locationId Location ID string
If not specified, defaults to the authenticated location.
Optional
name Name string
Full name of the contact, e.g. Rosan Deo
Optional
email Email string
Email of the contact, e.g. rosan@deos.com
Optional
phone Phone Number string
Phone number of the contact, e.g. +1 888-888-8888
Optional
additionalOptions Additional Options object
Additional parameters to send in the request. See the documentation for available parameters. Values will be parsed as JSON where applicable.
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
highlevel_oauth-create-contact
Version
0.0.4
App
HighLevel
Authentication
OAuth
Read-only
No
Destructive
Yes
Open world
Yes