---
title: "Company Job"
method: PATCH
path: "/companies/{companyId}/jobs/{jobId}"
tags: ["Company"]
---

# Company Job

`PATCH /companies/{companyId}/jobs/{jobId}`

## Request

- Base URL: `https://api.paychex.com`
- URL: `https://api.paychex.com/companies/{companyId}/jobs/{jobId}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/paychex/apis/external-api/docs/companies/:companyId/jobs/:jobId/patch.ts> (a function with typed inputs; its response is checked against the schema)

Update a single Job.

## Path parameters

- `companyId` string, required
- `jobId` string, required

## Request body

- JobResourcePatch: The state representation of Jobs within a company.
  - `jobId` string: The unique identifier associated with this job.
  - `jobCorrelationId` string: Id that you define which is used for error handling/responses.
  - `jobName` string: The name of the job.
  - `startDate` string, date-time: The start date associated with this job.
  - `endDate` string, date-time: The end date associated with this job.
  - `effectiveDate` string, date-time: Date which this pay component has started for the worker.
  - `links` Link[]
    - `rel` string
    - `href` string
    - `hreflang` string
    - `media` string
    - `title` string
    - `type` string
    - `deprecation` string
    - `profile` string
    - `name` string
  - `jobNumber` JobSegmentsResource: Data elements of a Job Number to show the segments and number.For segmentation this can be up to 3 different segments.
    - `segment1` string: This is segment 1 or the number associated to the job when segmentation is not used.
    - `segment2` string: This is segment 2.
    - `segment3` string: This is segment 3.

## Response `200`

successful operation

- object
  - `content` JobResource: The state representation of Jobs within a company.
    - `jobId` string: The unique identifier associated with this job.
    - `jobCorrelationId` string: Id that you define which is used for error handling/responses.
    - `jobName` string: The name of the job.
    - `startDate` string, date-time: The start date associated with this job.
    - `endDate` string, date-time: The end date associated with this job.
    - `links` Link[]
      - `rel` string
      - `href` string
      - `hreflang` string
      - `media` string
      - `title` string
      - `type` string
      - `deprecation` string
      - `profile` string
      - `name` string
    - `jobNumber` JobSegmentsResource: Data elements of a Job Number to show the segments and number.For segmentation this can be up to 3 different segments.
      - `segment1` string: This is segment 1 or the number associated to the job when segmentation is not used.
      - `segment2` string: This is segment 2.
      - `segment3` string: This is segment 3.
  - `links` Link[]
    - `rel` string
    - `href` string
    - `hreflang` string
    - `media` string
    - `title` string
    - `type` string
    - `deprecation` string
    - `profile` string
    - `name` string

## Other responses

- `400`: Invalid resource ID or Date (API-34)
- `401`: Unauthorized
- `403`: User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)
- `405`: Unsupported method type (API-59)
- `406`: Unsupported Accept header
- `500`: Internal Server Error.

---

[API](https://skmtc.dev/paychex/apis/external-api.md) - [All operations](https://skmtc.dev/paychex/apis/external-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paychex/apis/external-api/revisions/07161d3e073f?raw)