View as Markdown
Gem icon

Gem ACTION

Create Candidate

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

IMPLEMENTATION

Call this tool

Connect a user's Gem 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: "gem-create-candidate",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    gem: { authProvisionId: "apn_xxxxxxx" },
    createdBy: "Created By",
    firstName: "First 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
createdBy Created By string
Who the candidate was created by
Required Dynamic
firstName First Name string
Candidate's first name
Optional
lastName Last Name string
Candidate's last name
Optional
nickname Nickname string
Candidate's nickname
Optional
primaryEmail Primary Email Address string
Candidate's primary email address
Required
additionalEmails Email Addresses string[]
List of candidate's additional email addresses
Optional
linkedInHandle LinkedIn Handle string
Enter your candidate's unique LinkedIn identifier (e.g., "satyanadella"). This helps the system check for duplicates before creating a new candidate entry.
Optional
title Title string
Candidate's job title
Optional
company Company string
Candidate's company name
Optional
location Location string
Candidate's location
Optional
school School string
Candidate's school
Optional
educationInfoNumber Education Info Quantity integer
The number of education info objects to be created
Optional
workInfoNumber Work Info Quantity integer
The number of work info objects to be created
Optional
profileUrls Profile URLs string[]
If Profile URLs is provided with an array of urls, social profiles will be generated based on the provided urls and attached to the candidate
Optional
phoneNumber Phone Number string
Candidate's phone number
Optional
projectIds Project IDs string[]
If Project IDs is provided with an array of project ids, the candidate will be added into the projects once they are created.
Optional Dynamic
customFields Custom Fields object
An object containing new custom field values. Only custom fields specified are updated. Format: {"custom_field_id": "value"}. See the documentation for further details.
Optional
sourcedFrom Sourced From string
Where the candidate was sourced from
Optional
autofill Autofill boolean
Requires Linked In Handle to be non-null. Attempts to fill in any missing fields.
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
gem-create-candidate
Version
0.0.2
App
Gem
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes