--- title: "Update a job" url: "https://docs.unified.to/hris/job/Update_a_job" description: "Update a job with Unified's Job API (PUT /hris/{connection_id}/job/{id}). Filter by fields and raw." --- # Update a job PUT/hris/{connection\_id}/job/{id} ## Parameters **fields**string array id created\_at updated\_at name description code is\_active employment\_type company\_id groups locations parent\_id users compensation raw Fields to return **raw**string Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar **connection\_id**string required ID of the connection **id**string required ID of the Job ## Payload **id**string **created\_at**date-time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **updated\_at**date-time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **name**string the job or position title **description**string **code**string the integration's job code or position number, when it differs from id **is\_active**boolean **employment\_type** enum Valid values: "FULL\_TIME" "PART\_TIME" "CONTRACTOR" "INTERN" "CONSULTANT" "VOLUNTEER" "CASUAL" "SEASONAL" "FREELANCE" "OTHER" **company\_id**string (reference to HrisCompany) **groups** array the groups (departments, teams, organizations) this job belongs to. May not have all of the Group fields present, but should have id and name **locations** array where this job is worked. May not have all of the Location fields present, but should have id and name **parent\_id**string the hris\_job this job reports to (position hierarchy) **users** array the employees currently holding this job. May not have all of the Employee fields present, but should have id and name **compensation** array pay attached to the job itself (eg. an hourly rate) **raw** ## Returns [HrisJob](https://docs.unified.to/hris/job/model.md) | Response field | Type | Required | Description | | ---------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | id | string | No | | | created\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | updated\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | name | string | No | the job or position title | | description | string | No | | | code | string | No | the integration's job code or position number, when it differs from id | | is\_active | boolean | No | | | employment\_type | enum | No | Values: FULL\_TIME, PART\_TIME, CONTRACTOR, INTERN, CONSULTANT, VOLUNTEER, CASUAL, SEASONAL, FREELANCE, OTHER | | company\_id | string | No | (reference to HrisCompany) | | groups | [HrisGroup](https://docs.unified.to/hris/job/Update%5Fa%5Fjob.md#HrisGroup)\[\] | No | the groups (departments, teams, organizations) this job belongs to. May not have all of the Group fields present, but should have id and name | | groups\[\].id | string | No | | | groups\[\].created\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | groups\[\].updated\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | groups\[\].name | string | No | | | groups\[\].description | string | No | | | groups\[\].parent\_id | string | No | | | groups\[\].type | enum | No | Values: TEAM, GROUP, DEPARTMENT, DIVISION, BUSINESS\_UNIT, BRANCH, SUB\_DEPARTMENT, PAY\_GROUP | | groups\[\].user\_ids | string\[\] | No | (reference to HrisEmployee) | | groups\[\].manager\_ids | string\[\] | No | | | groups\[\].is\_active | boolean | No | | | groups\[\].company\_id | string | No | (reference to HrisCompany) | | groups\[\].pay\_frequency | enum | No | pay cycle when type is PAY\_GROUP Values: ONE\_TIME, DAY, QUARTER, YEAR, HOUR, MONTH, WEEK, BIWEEKLY, SEMIMONTHLY | | groups\[\].next\_paid\_at | string (date-time) | No | next pay date when type is PAY\_GROUP (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | locations | [HrisLocation](https://docs.unified.to/hris/job/Update%5Fa%5Fjob.md#HrisLocation)\[\] | No | where this job is worked. May not have all of the Location fields present, but should have id and name | | locations\[\].id | string | No | | | locations\[\].created\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | locations\[\].updated\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | locations\[\].name | string | No | | | locations\[\].description | string | No | | | locations\[\].address | object | No | | | locations\[\].address.address1 | string | No | | | locations\[\].address.address2 | string | No | | | locations\[\].address.city | string | No | | | locations\[\].address.region | string | No | | | locations\[\].address.region\_code | string | No | | | locations\[\].address.postal\_code | string | No | | | locations\[\].address.country | string | No | | | locations\[\].address.country\_code | string | No | ISO 2-digit country code | | locations\[\].parent\_id | string | No | | | locations\[\].external\_identifier | string | No | | | locations\[\].telephones | [HrisTelephone](https://docs.unified.to/hris/job/Update%5Fa%5Fjob.md#HrisTelephone)\[\] | No | | | locations\[\].telephones\[\].telephone | string | Yes | | | locations\[\].telephones\[\].type | enum | No | Values: WORK, HOME, OTHER, FAX, MOBILE | | locations\[\].timezone | string | No | | | locations\[\].currency | string | No | | | locations\[\].language\_locale | string | No | | | locations\[\].is\_active | boolean | No | | | locations\[\].is\_hq | boolean | No | if this location is the headquarters of the company | | locations\[\].company\_id | string | No | (reference to HrisCompany) | | parent\_id | string | No | the hris\_job this job reports to (position hierarchy) | | users | [HrisEmployee](https://docs.unified.to/hris/job/Update%5Fa%5Fjob.md#HrisEmployee)\[\] | No | the employees currently holding this job. May not have all of the Employee fields present, but should have id and name | | users\[\].id | string | No | | | users\[\].created\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | users\[\].updated\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | users\[\].name | string | No | | | users\[\].first\_name | string | No | | | users\[\].last\_name | string | No | | | users\[\].emails | [HrisEmail](https://docs.unified.to/hris/job/Update%5Fa%5Fjob.md#HrisEmail)\[\] | No | | | users\[\].emails\[\].email | string | Yes | | | users\[\].emails\[\].type | enum | No | Values: WORK, HOME, OTHER | | users\[\].title | string | No | | | users\[\].job\_id | string | No | the hris\_job (position) this employee holds; their primary job when they hold more than one | | users\[\].manager\_id | string | No | | | users\[\].employment\_status | enum | No | Values: ACTIVE, INACTIVE | | users\[\].gender | enum | No | Values: MALE, FEMALE, INTERSEX, TRANS, NON\_BINARY | | users\[\].telephones | [HrisTelephone](https://docs.unified.to/hris/job/Update%5Fa%5Fjob.md#HrisTelephone)\[\] | No | | | users\[\].telephones\[\].telephone | string | Yes | | | users\[\].telephones\[\].type | enum | No | Values: WORK, HOME, OTHER, FAX, MOBILE | | users\[\].date\_of\_birth | string (date-time) | No | YYYYMM/DD | | users\[\].employee\_number | string | No | the company's ID for this employee | | users\[\].hired\_at | string (date-time) | No | The employee's start date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | users\[\].terminated\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | users\[\].termination\_reason | string | No | | | users\[\].marital\_status | enum | No | Values: MARRIED, SINGLE | | users\[\].employment\_type | enum | No | Values: FULL\_TIME, PART\_TIME, CONTRACTOR, INTERN, CONSULTANT, VOLUNTEER, CASUAL, SEASONAL, FREELANCE, OTHER | | users\[\].address | object | No | | | users\[\].address.address1 | string | No | | | users\[\].address.address2 | string | No | | | users\[\].address.city | string | No | | | users\[\].address.region | string | No | | | users\[\].address.region\_code | string | No | | | users\[\].address.postal\_code | string | No | | | users\[\].address.country | string | No | | | users\[\].address.country\_code | string | No | ISO 2-digit country code | | users\[\].language\_locale | string | No | | | users\[\].currency | string | No | | | users\[\].timezone | string | No | | | users\[\].image\_url | string | No | This link expires after 1 hour. | | users\[\].company\_id | string | No | (reference to HrisCompany) | | users\[\].pronouns | string | No | | | users\[\].employee\_roles | enum | No | Values: ADMIN, MANAGER, RECRUITER, SALESREP, INTERVIEWER, USER, EMPLOYEE | | users\[\].compensation | [HrisCompensation](https://docs.unified.to/hris/job/Update%5Fa%5Fjob.md#HrisCompensation)\[\] | No | | | users\[\].compensation\[\].type | enum | No | Values: SALARY, BONUS, STOCK\_OPTIONS, EQUITY, OTHER, HOURLY, COMMISSION | | users\[\].compensation\[\].amount | number | No | | | users\[\].compensation\[\].currency | string | No | | | users\[\].compensation\[\].frequency | enum | No | Values: ONE\_TIME, DAY, QUARTER, YEAR, HOUR, MONTH, WEEK, BIWEEKLY, SEMIMONTHLY | | users\[\].compensation\[\].group\_id | string | No | (reference to HrisGroup) | | users\[\].compensation\[\].notes | string | No | | | users\[\].salutation | string | No | Mr. Mrs. Ms. | | users\[\].bio | string | No | | | users\[\].ssn\_sin | string | No | | | users\[\].groups | [HrisGroup](https://docs.unified.to/hris/job/Update%5Fa%5Fjob.md#HrisGroup)\[\] | No | Which groups/teams/units that this employee/user belongs to. May not have all of the Group fields present, but should have id, name, or email. | | users\[\].groups\[\].id | string | No | | | users\[\].groups\[\].created\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | users\[\].groups\[\].updated\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | users\[\].groups\[\].name | string | No | | | users\[\].groups\[\].description | string | No | | | users\[\].groups\[\].parent\_id | string | No | | | users\[\].groups\[\].type | enum | No | Values: TEAM, GROUP, DEPARTMENT, DIVISION, BUSINESS\_UNIT, BRANCH, SUB\_DEPARTMENT, PAY\_GROUP | | users\[\].groups\[\].user\_ids | string\[\] | No | (reference to HrisEmployee) | | users\[\].groups\[\].manager\_ids | string\[\] | No | | | users\[\].groups\[\].is\_active | boolean | No | | | users\[\].groups\[\].company\_id | string | No | (reference to HrisCompany) | | users\[\].groups\[\].pay\_frequency | enum | No | pay cycle when type is PAY\_GROUP Values: ONE\_TIME, DAY, QUARTER, YEAR, HOUR, MONTH, WEEK, BIWEEKLY, SEMIMONTHLY | | users\[\].groups\[\].next\_paid\_at | string (date-time) | No | next pay date when type is PAY\_GROUP (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | users\[\].locations | [HrisLocation](https://docs.unified.to/hris/job/Update%5Fa%5Fjob.md#HrisLocation)\[\] | No | | | users\[\].locations\[\].id | string | No | | | users\[\].locations\[\].created\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | users\[\].locations\[\].updated\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | users\[\].locations\[\].name | string | No | | | users\[\].locations\[\].description | string | No | | | users\[\].locations\[\].address | object | No | | | users\[\].locations\[\].address.address1 | string | No | | | users\[\].locations\[\].address.address2 | string | No | | | users\[\].locations\[\].address.city | string | No | | | users\[\].locations\[\].address.region | string | No | | | users\[\].locations\[\].address.region\_code | string | No | | | users\[\].locations\[\].address.postal\_code | string | No | | | users\[\].locations\[\].address.country | string | No | | | users\[\].locations\[\].address.country\_code | string | No | ISO 2-digit country code | | users\[\].locations\[\].parent\_id | string | No | | | users\[\].locations\[\].external\_identifier | string | No | | | users\[\].locations\[\].telephones | [HrisTelephone](https://docs.unified.to/hris/job/Update%5Fa%5Fjob.md#HrisTelephone)\[\] | No | | | users\[\].locations\[\].telephones\[\].telephone | string | Yes | | | users\[\].locations\[\].telephones\[\].type | enum | No | Values: WORK, HOME, OTHER, FAX, MOBILE | | users\[\].locations\[\].timezone | string | No | | | users\[\].locations\[\].currency | string | No | | | users\[\].locations\[\].language\_locale | string | No | | | users\[\].locations\[\].is\_active | boolean | No | | | users\[\].locations\[\].is\_hq | boolean | No | if this location is the headquarters of the company | | users\[\].locations\[\].company\_id | string | No | (reference to HrisCompany) | | users\[\].metadata | [HrisMetadata](https://docs.unified.to/hris/job/Update%5Fa%5Fjob.md#HrisMetadata)\[\] | No | | | users\[\].metadata\[\].id | string | No | | | users\[\].metadata\[\].value | object | No | | | users\[\].metadata\[\].namespace | string | No | | | users\[\].metadata\[\].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE\_SELECT, MULTIPLE\_SELECT, MEASUREMENT, PRICE, YES\_NO, CURRENCY, URL | | users\[\].metadata\[\].extra\_data | object | No | | | users\[\].metadata\[\].slug | string | No | | | users\[\].storage\_quota\_allocated | number | No | | | users\[\].storage\_quota\_used | number | No | | | users\[\].storage\_quota\_available | number | No | | | users\[\].relationships | [HrisEmployeerelationship](https://docs.unified.to/hris/job/Update%5Fa%5Fjob.md#HrisEmployeerelationship)\[\] | No | the employee's personal relationships (eg. emergency contacts, spouse, dependants, ...) | | users\[\].relationships\[\].name | string | No | | | users\[\].relationships\[\].first\_name | string | No | | | users\[\].relationships\[\].last\_name | string | No | | | users\[\].relationships\[\].emails | [HrisEmail](https://docs.unified.to/hris/job/Update%5Fa%5Fjob.md#HrisEmail)\[\] | No | | | users\[\].relationships\[\].emails\[\].email | string | Yes | | | users\[\].relationships\[\].emails\[\].type | enum | No | Values: WORK, HOME, OTHER | | users\[\].relationships\[\].telephones | [HrisTelephone](https://docs.unified.to/hris/job/Update%5Fa%5Fjob.md#HrisTelephone)\[\] | No | | | users\[\].relationships\[\].telephones\[\].telephone | string | Yes | | | users\[\].relationships\[\].telephones\[\].type | enum | No | Values: WORK, HOME, OTHER, FAX, MOBILE | | users\[\].relationships\[\].address | [HrisEmployeerelationship\_address](https://docs.unified.to/hris/job/Update%5Fa%5Fjob.md#HrisEmployeerelationship%5Faddress) | No | | | users\[\].relationships\[\].address.address1 | string | No | | | users\[\].relationships\[\].address.address2 | string | No | | | users\[\].relationships\[\].address.city | string | No | | | users\[\].relationships\[\].address.region | string | No | | | users\[\].relationships\[\].address.region\_code | string | No | | | users\[\].relationships\[\].address.postal\_code | string | No | | | users\[\].relationships\[\].address.country | string | No | | | users\[\].relationships\[\].address.country\_code | string | No | ISO 2-digit country code | | users\[\].relationships\[\].type | enum | No | Values: EMERGENCY, SPOUSE, CHILD, PARENT, SIBLING, FRIEND, OTHER | | users\[\].relationships\[\].is\_dependent | boolean | No | | | users\[\].relationships\[\].is\_beneficiary | boolean | No | | | users\[\].relationships\[\].start\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | users\[\].relationships\[\].end\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | users\[\].has\_mfa | boolean | No | does the user/employee have multi-factor authentication enabled | | users\[\].timeoff\_days\_total | number | No | Total time off allowance for the current leave period, in days (when reported by the provider) | | users\[\].timeoff\_days\_used | number | No | Time off days used or booked in the current leave period (when reported by the provider) | | users\[\].flsa\_status | enum | No | US Fair Labor Standards Act classification Values: EXEMPT, NON\_EXEMPT, SALARIED\_NONEXEMPT, OWNER | | users\[\].pay\_frequency | enum | No | how often the employee is paid (eg. BIWEEKLY) Values: ONE\_TIME, DAY, QUARTER, YEAR, HOUR, MONTH, WEEK, BIWEEKLY, SEMIMONTHLY | | compensation | [HrisCompensation](https://docs.unified.to/hris/job/Update%5Fa%5Fjob.md#HrisCompensation)\[\] | No | pay attached to the job itself (eg. an hourly rate) | | compensation\[\].type | enum | No | Values: SALARY, BONUS, STOCK\_OPTIONS, EQUITY, OTHER, HOURLY, COMMISSION | | compensation\[\].amount | number | No | | | compensation\[\].currency | string | No | | | compensation\[\].frequency | enum | No | Values: ONE\_TIME, DAY, QUARTER, YEAR, HOUR, MONTH, WEEK, BIWEEKLY, SEMIMONTHLY | | compensation\[\].group\_id | string | No | (reference to HrisGroup) | | compensation\[\].notes | string | No | | ## Errors Errors return the HTTP status code and a JSON body with `statusCode`, `error` (the short label) and `message` (a human-readable detail). ```json { "statusCode": 429, "error": "Too Many Requests", "message": "Too many requests to unified.to API; max requests per minute: N" } ``` | Status | Error | Meaning | | ------ | --------------------- | ------------------------------------------------- | | 400 | Bad Request | The request was malformed or failed validation. | | 401 | Unauthorized | The connection is likely broken; re-authorize it. | | 403 | Forbidden | The connection is missing permissions or scopes. | | 404 | Not Found | The requested resource does not exist. | | 429 | Too Many Requests | Rate limit exceeded (see the two sources below). | | 500 | Internal Server Error | An unexpected error occurred. | | 501 | Not Implemented | Not supported by this integration. | Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message. ### 429 Too Many Requests A 429 has two possible sources: * The integration's own rate limit, passed through. * Unified's workspace limit: a rolling 60 seconds, set by plan, with the message `Too many requests to unified.to API; max requests per minute: N`. ## Code Samples ### Node.js SDK ```javascript import { UnifiedTo } from '@unified-api/typescript-sdk'; const sdk = new UnifiedTo({ security: { jwt: '', }, }); const connectionId = '5de520f96e439b002043d8dc'; const id = '1234'; const results = await sdk.hris.updateHrisJob({ connectionId, id, hrisJob: { }, fields: '', raw: '', }); ``` ### Node.js (axios) ```javascript const options = { method: 'PUT', url: 'https://api.unified.to/hris/5de520f96e439b002043d8dc/job/5de520f96e439b002043d8d8', headers: { authorization: 'bearer .....' }, data: undefined, params: { fields: '', raw: '', } }; const results = await axios.request(options); ``` ### Java ```java AsyncHttpClient client = new DefaultAsyncHttpClient(); client.prepare("PUT", "https://api.unified.to/hris/5de520f96e439b002043d8dc/job/5de520f96e439b002043d8d8?fields=&raw=") .setHeader("accept", "application/json") .setHeader("authorization", ".....") .execute() .toCompletableFuture() .thenAccept(System.out::println) .join(); client.close(); ``` ### Go ```go import ( "fmt" "net/http" "io/ioutil" ) url := `https://api.unified.to/hris/5de520f96e439b002043d8dc/job/5de520f96e439b002043d8d8?fields=&raw= req, _ := http.NewRequest("PUT", url, nil) req.Header.Add("accept", "application/json") req.Header.Add("authorization", ".....") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) ``` ### Python ```python import requests url = "https://api.unified.to/hris/5de520f96e439b002043d8dc/job/5de520f96e439b002043d8d8?fields=&raw=" headers = { "accept": "application/json", "authorization": "....." } response = requests.put(url, headers=headers) ``` ### PHP ```php $curl = curl_init(); curl_setopt_array($curl, [ CURLOPT_URL => "https://api.unified.to/hris/5de520f96e439b002043d8dc/job/5de520f96e439b002043d8d8?fields=&raw=", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_HTTPHEADER => [ "accept: application/json", "authorization: ....." ], ]); ``` ### Ruby ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.unified.to/hris/5de520f96e439b002043d8dc/job/5de520f96e439b002043d8d8?fields=&raw=") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Put.new(url) request["accept"] = 'application/json' request["authorization"] = '....' response = http.request(request) puts response.read_body ``` ### cURL ```bash curl --request PUT \ --url 'https://api.unified.to/hris/5de520f96e439b002043d8dc/job/5de520f96e439b002043d8d8?fields=&raw=' \ --header 'accept: application/json' \ --header 'authorization: .....' ```