View as Markdown
Merge icon

Merge ACTION

Create Candidate

Create a new candidate profile. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Merge account once, then configure and run Create Candidate 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: "merge-create-candidate",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    merge: { authProvisionId: "apn_xxxxxxx" },
    firstName: "First Name",
    lastName: "Last 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 Candidate inputs
Property Type Description
firstName First Name string
The candidate's first name
Required
lastName Last Name string
The candidate's last name
Required
canEmail Can Email boolean
Whether or not the candidate can be emailed
Required
emailAddress Email Addresses string
The candidate's email address
Required
emailType Email Type string
The candidate's email address
Required
remoteUserId Remote User ID string
ID of the user that is sending the request
Required 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
merge-create-candidate
Version
0.0.2
App
Merge
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes