Update Employee

PATCH {{baseUrl}}/hris/employees/:id?raw=false

Update Employee

Request Params

KeyDatatypeRequiredDescription
rawbooleanInclude raw response. Mostly used for debugging purposes

Request Body

{"id"=>"12345", "first_name"=>"Elon", "last_name"=>"Musk", "middle_name"=>"D.", "display_name"=>"Technoking", "preferred_name"=>"Elon Musk", "initials"=>"EM", "salutation"=>"Mr", "title"=>"CEO", "marital_status"=>"married", "partner"=>{"first_name"=>"Elon", "last_name"=>"Musk", "middle_name"=>"D.", "gender"=>"male", "initials"=>"EM", "birthday"=>"2000-08-12", "deceased_on"=>"2000-08-12"}, "division"=>"Europe", "division_id"=>"12345", "department"=>"R&D", "department_id"=>"12345", "department_name"=>"12345", "team"=>{"id"=>"1234", "name"=>"Full Stack Engineers"}, "company_id"=>"{{primaryCompanyId}}", "company_name"=>"SpaceX", "employment_start_date"=>"2021-10-26", "employment_end_date"=>"2028-10-26", "leaving_reason"=>"resigned", "employee_number"=>"123456-AB", "employment_status"=>"active", "employment_role"=>{"type"=>"internship", "sub_type"=>"not_specified"}, "ethnicity"=>"African American", "manager"=>{"id"=>"12345", "name"=>"Elon Musk", "first_name"=>"Elon", "last_name"=>"Musk", "email"=>"elon@musk.com", "employment_status"=>"active"}, "direct_reports"=>["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "social_security_number"=>"123456789", "birthday"=>"2000-08-12", "deceased_on"=>"2000-08-12", "country_of_birth"=>"US", "description"=>"A description", "gender"=>"male", "pronouns"=>"she,her", "preferred_language"=>"EN", "languages"=>["EN"], "nationalities"=>["US"], "photo_url"=>"https://unavatar.io/elon-musk", "timezone"=>"Europe/London", "source"=>"lever", "source_id"=>"12345", "record_url"=>"https://app.intercom.io/contacts/12345", "jobs"=>[{"title"=>"Techno King", "compensation_rate"=>72000, "currency"=>"USD", "payment_unit"=>"year", "hired_at"=>"2020-08-12", "is_primary"=>true}], "works_remote"=>true, "addresses"=>[{"id"=>"123", "type"=>"primary", "string"=>"25 Spring Street, Blackburn, VIC 3130", "name"=>"HQ US", "line1"=>"Main street", "line2"=>"apt #", "line3"=>"Suite #", "line4"=>"delivery instructions", "street_number"=>"25", "city"=>"San Francisco", "state"=>"CA", "postal_code"=>"94104", "country"=>"US", "latitude"=>"40.759211", "longitude"=>"-73.984638", "county"=>"Santa Clara", "contact_name"=>"Elon Musk", "salutation"=>"Mr", "phone_number"=>"111-111-1111", "fax"=>"122-111-1111", "email"=>"elon@musk.com", "website"=>"https://elonmusk.com", "notes"=>"Address notes or delivery instructions.", "row_version"=>"{{employeeAddressRowVersion}}"}], "phone_numbers"=>[{"number"=>"111-111-1111", "id"=>"12345", "country_code"=>"1", "area_code"=>"323", "extension"=>"105", "type"=>"primary"}], "emails"=>[{"email"=>"elon@musk.com", "id"=>"123", "type"=>"primary"}], "social_links"=>[{"url"=>"https://www.twitter.com/apideck", "id"=>"12345", "type"=>"twitter"}], "bank_accounts"=>[{"bank_name"=>"Monzo", "account_number"=>"123465", "account_name"=>"SPACEX LLC", "account_type"=>"credit_card", "iban"=>"CH2989144532982975332", "bic"=>"AUDSCHGGXXX", "routing_number"=>"012345678", "bsb_number"=>"062-001", "branch_identifier"=>"001", "bank_code"=>"BNH", "currency"=>"USD"}], "tax_code"=>"1111", "tax_id"=>"234-32-0000", "dietary_preference"=>"Veggie", "food_allergies"=>["No allergies"], "probation_period"=>{"start_date"=>"2021-10-01", "end_date"=>"2021-11-28"}, "tags"=>["New"], "row_version"=>"{{employeeRowVersion}}", "deleted"=>true}

HEADERS

KeyDatatypeRequiredDescription
x-apideck-consumer-idstring(Required) ID of the consumer which you want to get or push data from
x-apideck-app-idstring(Required) The ID of your Unify application
x-apideck-service-idstringProvide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
Content-Typestring
Acceptstring

RESPONSES

status: OK

{"status_code":200,"status":"OK","service":"sage-hr","resource":"Employees","operation":"update","data":{"id":"12345"}}