# Add Candidate Note — Homerun

> Adds a note to a candidate's profile in Homerun. See the documentation.

- Key: `homerun-add-candidate-note`
- Type: Action (Write)
- Version: 0.0.2
- App: Homerun (`homerun`) — https://pipedream.com/apps/homerun.md
- This page (HTML): https://pipedream.com/apps/homerun/actions/add-candidate-note
- Hints: open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/homerun/actions/add-candidate-note/add-candidate-note.mjs

## Description

Adds a note to a candidate's profile in Homerun. [See the documentation](https://developers.homerun.co/#tag/Job-Application-Notes/operation/job-applications.job-application-id.notes.post).

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `jobApplicationId` | `string` | Yes | The ID of the job application. Options are loaded from the connected account. |
| `note` | `string` | Yes | The content of the note to add. |
| `displayName` | `string` | Yes | Name of the note's author. |

## 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": "homerun",
      },
    },
  },
)

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: "homerun-add-candidate-note",
  arguments: {
    jobApplicationId: "Job Application ID",
    note: "Note Content",
  },
})
```

**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: "homerun-add-candidate-note",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    homerun: { authProvisionId: "apn_xxxxxxx" },
    jobApplicationId: "Job Application ID",
    note: "Note Content",
  },
})

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": "homerun-add-candidate-note",
    "configured_props": {
      "homerun": { "authProvisionId": "apn_xxxxxxx" },
      "jobApplicationId": "Job Application ID",
      "note": "Note Content"
    }
  }'
```

---

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