# Create Prospect — Outreach

> Creates a new prospect in Outreach. See the documentation

- Key: `outreach-create-prospect`
- Type: Action (Write)
- Version: 0.0.2
- App: Outreach (`outreach`) — https://pipedream.com/apps/outreach.md
- This page (HTML): https://pipedream.com/apps/outreach/actions/create-prospect
- Hints: open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/outreach/actions/create-prospect/create-prospect.mjs

## Description

Creates a new prospect in Outreach. [See the documentation](https://developers.outreach.io/api/reference/tag/Prospect/#tag/Prospect/paths/~1prospects/post)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `addedAt` | `string` | No | The date and time the prospect was added to any system. Format: 'YYYY-MM-DDTHH:MM:SS.UUUZ' |
| `addressCity` | `string` | No | The prospect's city (e.g. "Seattle"). |
| `addressCountry` | `string` | No | The prospect's country (e.g. "USA"). |
| `addressState` | `string` | No | The prospect's state (e.g. "Washington"). |
| `addressStreet` | `string` | No | The prospect's street address (e.g. "1441 N 34th St"). |
| `addressStreet2` | `string` | No | The prospect's second street address, if applicable. |
| `addressZip` | `string` | No | The prospect's postal code (e.g. "98103"). |
| `angelListUrl` | `string` | No | The prospect's AngelList URL. |
| `availableAt` | `string` | No | The date and time the prospect is available to contact again. Format: 'YYYY-MM-DDTHH:MM:SS.UUUZ' |
| `campaignName` | `string` | No | The name of the campaign the prospect is associated with. |
| `company` | `string` | No | 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). |
| `dateOfBirth` | `string` | No | The date the prospect was born. Format YYYY-MM-DD |
| `degree` | `string` | No | The degree(s) the prospect has received. |
| `emails` | `string[]` | No | A list of email addresses associated with the prospect. |
| `eventName` | `string` | No | The name of the event the prospect was met at. |
| `externalId` | `string` | No | A custom ID for the prospect, often referencing an ID in an external system. |
| `externalOwner` | `string` | No | A custom owner for the prospect, often referencing an ownering in an external system. |
| `externalSource` | `string` | No | The source of the resource's creation (e.g. "outreach-api"). |
| `facebookUrl` | `string` | No | The prospect's Facebook URL. |
| `firstName` | `string` | No | The first name of the prospect. |
| `gender` | `string` | No | The gender of the prospect. |
| `githubUrl` | `string` | No | The prospect's GitHub URL. |
| `githubUsername` | `string` | No | The prospect's GitHub username. |
| `googlePlusUrl` | `string` | No | The prospect's Google+ URL. |
| `graduationDate` | `string` | No | The graduation date of the prospect. |
| `homePhones` | `string[]` | No | A list of home phone numbers associated with the prospect. |
| `jobStartDate` | `string` | No | The starting date of the prospect's current job. |
| `lastName` | `string` | No | The last name of the prospect. |
| `linkedInConnections` | `integer` | No | The number of connections on the prospect's LinkedIn profile. |
| `linkedInId` | `string` | No | The prospect's LinkedIn ID. |
| `linkedInUrl` | `string` | No | The prospect's LinkedIn URL. |
| `middleName` | `string` | No | The middle name of the prospect. |
| `mobilePhones` | `string[]` | No | A list of mobile phone numbers associated with the prospect. |
| `nickname` | `string` | No | The nickname of the prospect. |
| `occupation` | `string` | No | The occupation of the prospect (e.g. "Purchasing Manager"). |
| `optedOut` | `boolean` | No | 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. |
| `otherPhones` | `string[]` | No | A list of other phone numbers associated with the prospect. |
| `personalNote1` | `string` | No | A custom note field related to the prospect. |
| `personalNote2` | `string` | No | A second note field related to the prospect. |
| `preferredContact` | `string` | No | The preferred contact method for the prospect. |
| `quoraUrl` | `string` | No | The prospect's Quora URL. |
| `region` | `string` | No | The primary geographic region of the prospect. |
| `school` | `string` | No | The school(s) the prospect has attended. |
| `score` | `string` | No | A custom score given to measure the quality of the lead. |
| `sharingTeamId` | `string` | No | The ID of the sharing team associated with this object. Access is currently in beta. |
| `source` | `string` | No | A custom source representing where the lead was first acquired. |
| `specialties` | `string` | No | A description of the prospect's specialties. |
| `stackOverflowId` | `string` | No | The prospect's StackOverflow ID. |
| `stackOverflowUrl` | `string` | No | The prospect's StackOverflow URL. |
| `tags` | `string[]` | No | A list of tag values associated with the account (e.g. ["Interested", "2017 Expo"]). |
| `timeZone` | `string` | No | The prospect's current timezone, preferably in the IANA format (e.g. "America/LosAngeles"). |
| `title` | `string` | No | The title of the prospect. |
| `twitterUrl` | `string` | No | The prospect's Twitter URL. |
| `twitterUsername` | `string` | No | The prospect's Twitter username. |
| `voipPhones` | `string[]` | No | A list of voip phone numbers associated with the prospect. |
| `websiteUrl1` | `string` | No | The URL of the prospect's website. |
| `websiteUrl2` | `string` | No | The value of the prospect's second website URL field. |
| `websiteUrl3` | `string` | No | The value of the prospect's third website URL field. |
| `workPhones` | `string[]` | No | A list of work phone numbers associated with the prospect. |
| `custom1` | `string` | No | The value of the first custom field. |
| `custom2` | `string` | No | The value of the second custom field. |
| `custom3` | `string` | No | The value of the third custom field. |
| `custom4` | `string` | No | The value of the fourth custom field. |
| `custom5` | `string` | No | The value of the fifth custom field. |
| `custom6` | `string` | No | The value of the sixth custom field. |
| `custom7` | `string` | No | The value of the seventh custom field. |
| `custom8` | `string` | No | The value of the eight custom field. |
| `custom9` | `string` | No | The value of the ninth custom field. |
| `custom10` | `string` | No | The value of the 10th custom field. |
| `custom11` | `string` | No | The value of the 11th custom field. |
| `custom12` | `string` | No | The value of the 12th custom field. |
| `custom13` | `string` | No | The value of the 13th custom field. |
| `custom14` | `string` | No | The value of the 14th custom field. |
| `custom15` | `string` | No | The value of the 15th custom field. |
| `custom16` | `string` | No | The value of the 16th custom field. |
| `custom17` | `string` | No | The value of the 17th custom field. |
| `custom18` | `string` | No | The value of the 18th custom field. |
| `custom19` | `string` | No | The value of the 19th custom field. |
| `custom20` | `string` | No | The value of the 20th custom field. |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_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",
  },
})
```

**TypeScript**

```ts
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**

```bash
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"
    }
  }'
```

---

- App: https://pipedream.com/apps/outreach.md · All apps: https://pipedream.com/apps