View as Markdown
Recruiterflow icon

Recruiterflow ACTION

Create Candidate

Creates a new candidate in Recruiterflow. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Recruiterflow 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: "recruiterflow-create-candidate",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    recruiterflow: { authProvisionId: "apn_xxxxxxx" },
    name: "Name",
    email: "Email",
  },
})

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
name Name string
Full name of the candidate
Required
email Email string
Primary email address of the candidate
Optional
phoneNumber Phone Number string
Primary phone number of the candidate
Optional
title Job Title string
Current job title of the candidate
Optional
organization Organization string
Current organization/company of the candidate
Optional
location Location string
Location of the candidate (e.g., 'New York Metropolitan Area')
Optional
linkedinProfile LinkedIn Profile string
LinkedIn profile URL
Optional
twitterProfile Twitter Profile string
Twitter profile URL
Optional
facebookProfile Facebook Profile string
Facebook profile URL
Optional
githubProfile GitHub Profile string
GitHub profile URL
Optional
angellistProfile AngelList Profile string
AngelList profile URL
Optional
source Source string
Source of the candidate (e.g., 'linkedin', 'referral', 'website')
Optional
tags Tags string[]
Tags to categorize the candidate
Optional
skills Skills string[]
Array of candidate skills
Optional
leadOwnerId Lead Owner ID string
ID of the user who will own this candidate
Optional Dynamic
experience Experience string[]
Array of experience objects. Format: [{"organization": "Facebook", "designation": "SDE", "from": ["2", "2021"], "to": ["2", "2021"]}]
Optional
education Education string[]
Array of education objects. Format: [{"school": "HPCA", "degree": "10th", "specialization": "MATHS", "from": ["5", "2021"], "to": ["5", "2022"]}]
Optional
customFields Custom Fields string[]

Array of custom field objects. Example:

[
  {
    "id": 16,
    "value": {"currency": "USD", "number": 600000}
  },
  {
    "id": 17,
    "value": {"currency": "USD", "number1": 600000, "number2": 800000}
  },
  {
    "id": 19,
    "value": {"number1": 600000, "number2": 800000}
  },
  {
    "id": 20,
    "value": ["choice1", "choice2"]
  },
  {
    "id" : 33,
    "value" : "Random"
  }
]

See the API documentation for more details.

Optional
addedTime Added Time string
Timestamp for backdating candidate creation (ISO 8601 format, e.g., 2021-01-12T10:16:16+0000)
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
recruiterflow-create-candidate
Version
0.0.1
App
Recruiterflow
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes