View as Markdown
Greenhouse icon

Greenhouse ACTION

Create Prospect

Creates a new prospect entry in Greenhouse. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Greenhouse account once, then configure and run Create Prospect 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: "greenhouse-create-prospect",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    greenhouse: { authProvisionId: "apn_xxxxxxx" },
    userId: "User Id",
    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 Prospect inputs
Property Type Description
userId User Id string
The identification of the user who is registering.
Required Dynamic
firstName First Name string
The person's first name.
Required
lastName Last Name string
The person's last name.
Required
company Company string
The person's company.
Optional
title Title string
The person's title.
Optional
phoneNumbers Phone Numbers string[]
A list of phone numbers. The phone number includes a plus sign (+), then country code, city code, and local phone number.
Optional
addressses Addressses string[]
A list of addresses.
Optional
emailAddresses Email Addresses string[]
A list of email addresses.
Optional
websiteAddresses Website Addresses string[]
A list of website addresses .
Optional
socialMediaAddresses Social Media Addresses string[]
A list of social media addresses.
Optional
tags Tags string[]
A list of tags as strings.
Optional
customFields Custom Fields object
An object containing new custom field values. The fields are the custom field Id.
Optional
recruiterId Recruiter Id string
The ID of the recruiter - either id or email must be present.
Optional Dynamic
recruiterEmail Recruiter Email string
The email of the recruiter - either id or email must be present.
Optional
coordinatorId Coordinator Id string
The ID of the coordinator - either id or email must be present.
Optional Dynamic
coordinatorEmail Coordinator Email string
The email of the coordinator - either id or email must be present.
Optional
jobIds Job Ids string[]
An array of job ids to which the person will be assigned.
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
greenhouse-create-prospect
Version
0.0.3
App
Greenhouse
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes