View as Markdown
CATS icon

CATS ACTION

Create Candidate

Create a new candidate in your CATS database. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's CATS 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: "cats-create-candidate",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    cats: { authProvisionId: "apn_xxxxxxx" },
    checkDuplicate: true,
    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
checkDuplicate Check Duplicate boolean
When this flag is set to true, if a duplicate record is found to the one being created, an error will be thrown instead of creating a duplicate record.
Required
firstName First Name string
The first name of the record.
Required
middleName Middle Name string
The middle name of the record.
Optional
lastName Last Name string
The last name of the record.
Required
title Title string
The record's job title.
Optional
emails Emails string[]
An array of email objects. Each email object should contain two keys: email and is_primary, as described here. Format: {"email":"example@email.com", "is_primary":"true"}
Optional
phones Phones string[]
An array of phone objects. Each phone object should contain three keys: number, extension, and type, as described here. Format: {"number":"+16124063451", "extension":"8371", "type":"mobile"}. Type can be mobile, home, work, fax, main or other
Optional
addressStreet Street Address string
The street of the record's address.
Optional
addressCity City Address string
The city of the record's address.
Optional
addressState State Address string
The state of the record's address.
Optional
addressPostalCode Address Postal Code string
The postal code of the record's address.
Optional
countryCode Country Code string
The country code of the record.
Optional
socialMediaUrls Social Media URLs string[]
The social media URLs of the record.
Optional
website Website string
The website of the record.
Optional
bestTimeToCall Best Time to Call string
The best time to call the record. Format: HH:MM.
Optional
currentEmployer Current Employer string
The current employer of the record.
Optional
dateAvailable Date Available string
The date the record is available for an opening. Format: YYYY-MM-DD.
Optional
currentPay Current Pay string
The current pay of the record.
Optional
desiredPay Desired Pay string
The desired pay for the record.
Optional
isWillingToRelocate Willing to Relocate boolean
Whether the record is willing to relocate.
Optional
keySkills Key Skills string
The key skills of the record.
Optional
notes Notes string
Any notes about the record.
Optional
source Source string
The source of the record.
Optional
ownerId Owner ID integer
The user id of the record owner.
Optional Dynamic
isActive Is Active boolean
A flag indicating if the candidate is active.
Optional
isHot Is Hot boolean
Whether the record is marked as hot.
Optional
password password string
The candidate's password if they are "registering".
Optional
customFields Custom Fields string[]
An array of custom field objects.
Optional Dynamic
workHistory Work History string[]
An array of work history objects. Example: {"title": "Engineer", "employer": { "linked": false, "name": "<employer name>", "location": { "city": "<employer city>", "state": "<employer state>" }}, "supervisor": { "linked": false, "name": "<supervisor name>", "phone": "<supervisor phone number>" }, "is_verified": true, "is_current": false, "start_date": "YYYY-MM-DD", "end_date": "YYYY-MM-DD", "reason_for_leaving": "foo"}
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
cats-create-candidate
Version
0.0.2
App
CATS
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes