View as Markdown
Hyros icon

Hyros ACTION

Create Lead

Create a new lead. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Hyros account once, then configure and run Create 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: "hyros-create-lead",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    hyros: { authProvisionId: "apn_xxxxxxx" },
    email: "Email",
    firstName: "First 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 Lead inputs
Property Type Description
email Email string
Email of the lead that will be created. If no email is entered, a phone number is required.
Optional
firstName First Name string
First name of the lead.
Optional
lastName Last Name string
Last name of the lead.
Optional
tags Tags string[]
A list of tags that will be applied to the lead.
Optional
leadIps Lead IPs string[]
IPs of the lead that will be created. Will be used to the Ad attributing proccess.
Optional
phoneNumbers Phone Numbers string[]
Phone numbers of the lead that will be created. Will be used on the Ad attributing proccess. If no email is entered, a phone number is required.
Optional
stage Lead Stage string
The name of a stage to be applied 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
hyros-create-lead
Version
0.0.3
App
Hyros
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes