Outreach ACTION
Create Prospect
Creates a new prospect in Outreach. See the documentation
- Action
- Writes data
- OAuth
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Outreach 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: "outreach-create-prospect",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
outreach: { authProvisionId: "apn_xxxxxxx" },
addedAt: "Added At",
addressCity: "Address City",
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "outreach-create-prospect",
"configured_props": {
"outreach": { "authProvisionId": "apn_xxxxxxx" },
"addedAt": "Added At",
"addressCity": "Address City"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "outreach",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "outreach-create-prospect",
arguments: {
addedAt: "Added At",
addressCity: "Address City",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
addedAt Added At | string | The date and time the prospect was added to any system. Format: 'YYYY-MM-DDTHH:MM:SS.UUUZ' Optional |
addressCity Address City | string | The prospect's city (e.g. "Seattle"). Optional |
addressCountry Address Country | string | The prospect's country (e.g. "USA"). Optional |
addressState Address State | string | The prospect's state (e.g. "Washington"). Optional |
addressStreet Address Street | string | The prospect's street address (e.g. "1441 N 34th St"). Optional |
addressStreet2 Address Street 2 | string | The prospect's second street address, if applicable. Optional |
addressZip Address Zip | string | The prospect's postal code (e.g. "98103"). Optional |
angelListUrl Angel List URL | string | The prospect's AngelList URL. Optional |
availableAt Available At | string | The date and time the prospect is available to contact again. Format: 'YYYY-MM-DDTHH:MM:SS.UUUZ' Optional |
campaignName Campaign Name | string | The name of the campaign the prospect is associated with. Optional |
company Company | string | The name of the company the prospect works at. If associated with an account, this is the name of the account. (e.g. Acme International). Optional |
dateOfBirth Date Of Birth | string | The date the prospect was born. Format YYYY-MM-DD Optional |
degree Degree | string | The degree(s) the prospect has received. Optional |
emails Emails | string[] | A list of email addresses associated with the prospect. Optional |
eventName Event Name | string | The name of the event the prospect was met at. Optional |
externalId External Id | string | A custom ID for the prospect, often referencing an ID in an external system. Optional |
externalOwner External Owner | string | A custom owner for the prospect, often referencing an ownering in an external system. Optional |
externalSource External Source | string | The source of the resource's creation (e.g. "outreach-api"). Optional |
facebookUrl Facebook URL | string | The prospect's Facebook URL. Optional |
firstName First Name | string | The first name of the prospect. Optional |
gender Gender | string | The gender of the prospect. Optional |
githubUrl GitHub URL | string | The prospect's GitHub URL. Optional |
githubUsername GitHub Username | string | The prospect's GitHub username. Optional |
googlePlusUrl Google Plus URL | string | The prospect's Google+ URL. Optional |
graduationDate Graduation Date | string | The graduation date of the prospect. Optional |
homePhones Home Phones | string[] | A list of home phone numbers associated with the prospect. Optional |
jobStartDate Job Start Date | string | The starting date of the prospect's current job. Optional |
lastName Last Name | string | The last name of the prospect. Optional |
linkedInConnections LinkedIn Connections | integer | The number of connections on the prospect's LinkedIn profile. Optional |
linkedInId LinkedIn Id | string | The prospect's LinkedIn ID. Optional |
linkedInUrl LinkedIn URL | string | The prospect's LinkedIn URL. Optional |
middleName Middle Name | string | The middle name of the prospect. Optional |
mobilePhones Mobile Phones | string[] | A list of mobile phone numbers associated with the prospect. Optional |
nickname Nickname | string | The nickname of the prospect. Optional |
occupation Occupation | string | The occupation of the prospect (e.g. "Purchasing Manager"). Optional |
optedOut Opted Out | boolean | A boolean value representing whether this prospect is currently opted out of all mailings. Set this value to true to opt out the prospect; the 'opted_out' timestamp will be updated to the time of the request. Set this value to false to revert the opt at and clear the opted out timestamp. Optional |
otherPhones Other Phones | string[] | A list of other phone numbers associated with the prospect. Optional |
personalNote1 Personal Note 1 | string | A custom note field related to the prospect. Optional |
personalNote2 Personal Note 2 | string | A second note field related to the prospect. Optional |
preferredContact Preferred Contact | string | The preferred contact method for the prospect. Optional |
quoraUrl Quora URL | string | The prospect's Quora URL. Optional |
region Region | string | The primary geographic region of the prospect. Optional |
school School | string | The school(s) the prospect has attended. Optional |
score Score | string | A custom score given to measure the quality of the lead. Optional |
sharingTeamId Sharing Team Id | string | The ID of the sharing team associated with this object. Access is currently in beta. Optional |
source Source | string | A custom source representing where the lead was first acquired. Optional |
specialties Specialties | string | A description of the prospect's specialties. Optional |
stackOverflowId Stack Overflow Id | string | The prospect's StackOverflow ID. Optional |
stackOverflowUrl StackOverflow URL | string | The prospect's StackOverflow URL. Optional |
tags Tags | string[] | A list of tag values associated with the account (e.g. ["Interested", "2017 Expo"]). Optional |
timeZone TimeZone | string | The prospect's current timezone, preferably in the IANA format (e.g. "America/LosAngeles"). Optional |
title Title | string | The title of the prospect. Optional |
twitterUrl Twitter URL | string | The prospect's Twitter URL. Optional |
twitterUsername Twitter Username | string | The prospect's Twitter username. Optional |
voipPhones Voip Phones | string[] | A list of voip phone numbers associated with the prospect. Optional |
websiteUrl1 Website URL 1 | string | The URL of the prospect's website. Optional |
websiteUrl2 Website URL 2 | string | The value of the prospect's second website URL field. Optional |
websiteUrl3 Website URL 3 | string | The value of the prospect's third website URL field. Optional |
workPhones Work Phones | string[] | A list of work phone numbers associated with the prospect. Optional |
custom1 Custom 1 | string | The value of the first custom field. Optional |
custom2 Custom 2 | string | The value of the second custom field. Optional |
custom3 Custom 3 | string | The value of the third custom field. Optional |
custom4 Custom 4 | string | The value of the fourth custom field. Optional |
custom5 Custom 5 | string | The value of the fifth custom field. Optional |
custom6 Custom 6 | string | The value of the sixth custom field. Optional |
custom7 Custom 7 | string | The value of the seventh custom field. Optional |
custom8 Custom 8 | string | The value of the eight custom field. Optional |
custom9 Custom 9 | string | The value of the ninth custom field. Optional |
custom10 Custom 10 | string | The value of the 10th custom field. Optional |
custom11 Custom 11 | string | The value of the 11th custom field. Optional |
custom12 Custom 12 | string | The value of the 12th custom field. Optional |
custom13 Custom 13 | string | The value of the 13th custom field. Optional |
custom14 Custom 14 | string | The value of the 14th custom field. Optional |
custom15 Custom 15 | string | The value of the 15th custom field. Optional |
custom16 Custom 16 | string | The value of the 16th custom field. Optional |
custom17 Custom 17 | string | The value of the 17th custom field. Optional |
custom18 Custom 18 | string | The value of the 18th custom field. Optional |
custom19 Custom 19 | string | The value of the 19th custom field. Optional |
custom20 Custom 20 | string | The value of the 20th custom field. 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
- outreach-create-prospect
- Version
- 0.0.2
- App
- Outreach
- Authentication
- OAuth
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗