View as Markdown
Rex icon

Rex ACTION

Create Lead

Creates a new lead in Rex. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Rex 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: "rex-create-lead",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    rex: { authProvisionId: "apn_xxxxxxx" },
    leadType: "Lead Type",
    contactId: "Contact",
  },
})

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
leadType Lead Type string
The type of lead
Required
contactId Contact string
Identifier of a contact
Required Dynamic
sourceId Source string
Identifier of a source
Required Dynamic
note Note string
Message filled in by the user about the reason for contact
Required
listingId Listing string
Identifier of a listing
Optional Dynamic
propertyId Property string
Identifier of a property
Optional Dynamic
projectId Project string
Identifier of a project
Optional Dynamic
projectStageId Project Stage string
Identifier of a project stage
Optional Dynamic
assigneeId Assignee string
Identifier of the account/agent that will manage the lead
Optional Dynamic

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
rex-create-lead
Version
0.0.2
App
Rex
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes