View as Markdown
TalentHR icon

TalentHR ACTION

Update Employee

Allows updating an existing employee's data in the system. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's TalentHR account once, then configure and run Update Employee 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: "talenthr-update-employee",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    talenthr: { authProvisionId: "apn_xxxxxxx" },
    employeeId: "Employee ID",
    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.

Update Employee inputs
Property Type Description
employeeId Employee ID string
The ID of the employee
Required Dynamic
firstName First Name string
The first name of the new employee
Required
lastName Last Name string
The last name of the new employee
Required
email Email string
The email address of the new employee
Required
reportsToEmployeeId Reports To Employee ID string
If the Reports To Employee ID is 'null' then the current employee will be the head of the company.
Optional Dynamic
ssn SSN string
The social security number of the employee
Optional
birthDate Birth Date string
The birth date must be formatted as 'YYYY-MM-DD' and must be between now and 1930-01-01.
Optional
personalEmail Personal Email string
The email has to be unique (among personal emails).
Optional
maritalStatus Marital Status string
The marital status of the employee
Optional
gender Gender string
The gender of the employee
Optional
nationality Nationality string
The nationality of the employee
Optional Dynamic
citizenship Citizenship string
The citizenship of the employee
Optional
workPhone Work Phone string
The phone number of the employee's work
Optional
mobilePhone Mobile Phone string
The mobile phone numbe of the employee
Optional
phone Phone string
The phone numbe of the employee
Optional
address Address string
The address where the meeting will take place. Required if Who ID and When Time is present.
Optional
country Country string
The country where the employee lives
Optional Dynamic
postalCode Postal Code string
The postal code where the employee lives
Optional
city City string
The city where the employee lives
Optional
emergencyContactFullName Emergency Contact Name string
The emergency contact's full name
Optional
emergencyContactRelationshipTypeId Emergency Contact Relationship Type string
The type of the emergency contact's relationship
Optional Dynamic
emergencyContactPhone Emergency Contact Phone string
The emergency contact's phone number
Optional
emergencyContactAddress Emergency Contact Address string
The emergency contact's address
Optional
linkedInUrl LinkedIn string
The URL of the linkedIn
Optional
employeeNumber Employee Number string
An external number of the employee
Optional
passportNumber Passport Number string
The number of the employee's passport
Optional
passportIssuedDate Passport Issued Date string
The issued date of the employee's passport. Format YYYY-MM-DD
Optional
passportExpiryDate Passport Expiry Date string
The expiry date of the employee's passport. Format YYYY-MM-DD
Optional
passportIssuingCountry Passport Issue Country string
The issuing country of the employee's passport
Optional
visaType Visa Type string
The type of the employee's visa
Optional
visaNumber Visa Number string
The number of the employee's visa
Optional
visaExpiryDate Visa Expiry Date string
The expiry date of the employee's visa. Format YYYY-MM-DD
Optional
driverLicenseNumber Driver License Number string
The number of the employee's driver license
Optional
driverLicenseIssuedDate Driver License Issued Date string
The issued date of the employee's driver license. Format YYYY-MM-DD
Optional
driverLicenseExpiryDate Driver License Expiry Date string
The expiry date of the employee's driver license. Format YYYY-MM-DD
Optional
driverLicenseIssuingCountry Driver License Issue Country string
The issuing country of the employee's driver license
Optional
secAddress Second Address string
An employee's aditional address
Optional
secCity Second City string
An employee's aditional city
Optional
secPostalCode Second Postal Code string
An employee's aditional postal code
Optional
secCountry Second Country string
An employee's aditional country
Optional
twitterUrl Twitter string
The employee's Twitter URL
Optional
facebookUrl Facebook string
The employee's Facebook URL
Optional
instagramUrl Instagram string
The employee's Instagram URL
Optional
pinterestUrl Pinterest string
The employee's Pinterest URL
Optional
githubUrl GitHub string
The employee's GitHub URL
Optional
behanceUrl Behance string
The employee's Behance URL
Optional
skypeName Skype Name string
The employee's Skype name
Optional
shirtSize Shirt Size string
The size of the shirt the employee wears
Optional
tShirtSize T-Shirt Size string
The size of the t-shirt the employee wears
Optional
hrLanguages HR Languages integer[]
A list of language ids
Optional
hrFamily HR Family string[]
An array of family objects. Example: {"name": "Jhon Doe", "gender": "Male", "birth_date": "2001-10-10", "family_member_relationship_id": "1" }
Optional
allergies Allergies string
The employee's allegies
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
talenthr-update-employee
Version
0.0.4
App
TalentHR
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes