---
title: "Patch a job group"
method: PATCH
path: "/v1/jobGroups/{jobGroupId}"
tags: ["JobGroups"]
---

# Patch a job group

`PATCH /v1/jobGroups/{jobGroupId}`

Patch a job group (required scope jobs:write)

## Path parameters

- `jobGroupId` integer, required

## Headers

- `Customer-Id` integer, required

## Request body

- UpdateJobGroupModel — Update job group request model. At least one optional value must be provided
  - `reference` string, nullable — The internal reference of a job group - should usually be unique. If not provided and auto-referencing is setup, auto-reference value will be used<br/><br/>Max length: 40 characters<br/><br/>Optional: Omit to retain current value or provide null to unset
  - `contactId` integer — The unique identifier of the contact the job group is for<br/><br/>Must be a positive integer within the range of a 32-bit signed int<br/><br/>Must reference an existing contact<br/><br/>Optional: Omit to retain current value
  - `personId` string, uuid, nullable — The unique uuid identifier of the person who will serve as primary point of contact for the job<br/><br/>If provided, must belong to the specified contact (or existing job group's contact if ContactId not provided)<br/><br/>If not provided, the existing job group's person will be validated against the provided contact (if ContactId is given)<br/><br/>Optional: Omit to retain current value or provide null to unset
  - `title` string, nullable — The title of the job group<br/><br/>Max length: 50 characters<br/><br/>Optional: Omit to retain current value or provide null to unset
  - `isShownOnDevice` boolean — Indicates whether the job group is shown on the device. If true, it will be shown<br/><br/>Optional: Omit to retain current value
  - `orderNumber` string, nullable — The order number associated with the job group<br/><br/>Max length: 40 characters<br/><br/>Optional: Omit to retain current value or provide null to unset
  - `plannedStartOption` 'onSetDate' | 'dateOfFirstJob' — Represents the options for setting the planned start date of a job group<p>Possible values:</p><ul><li><b>onSetDate</b>: On a specific date</li><li><b>dateOfFirstJob</b>: The date of the first job in the job group</li></ul>
  - `plannedStartAt` string, date-time, nullable — The UTC timestamp for when the job group should be started. Should be set if the PlannedStartOption is JobGroupPlannedStartOptions.OnSetDate<br/><br/>If PlannedStartOption is DateOfFirstJob, this must be null<br/><br/>If PlannedStartOption is not provided, its requirement or nullability depends on the existing job group's start option<br/><br/>Optional: Omit to retain current value or provide null to unset
  - `plannedEndOption` 'onSetDate' | 'dateOfLastJob' — Represents the options for setting the planned end date of a job group<p>Possible values:</p><ul><li><b>onSetDate</b>: On a specific date</li><li><b>dateOfLastJob</b>: The date of the last job in the job group</li></ul>
  - `plannedEndAt` string, date-time, nullable — The UTC timestamp for when the job group should be ended. Should be set if the PlannedEndOption is JobGroupPlannedEndOptions.OnSetDate<br/><br/>If PlannedEndOption is DateOfLastJob, this must be null<br/><br/>If PlannedEndOption is not provided, its requirement or nullability depends on the existing job group's end option<br/><br/>If both PlannedStartAt and PlannedEndAt are OnSetDate, PlannedEndAt must be after PlannedStartAt<br/><br/>Optional: Omit to retain current value or provide null to unset
  - `categoryId` integer, nullable — The unique identifier of the category that the job group is assigned to<br/><br/>Must be a positive integer within the range of a 32-bit signed int and reference an existing category<br/><br/>Optional: Omit to retain current value or provide null to unset
  - `areJobsLinked` boolean — Determines whether the jobs are linked<br/><br/>Cannot be set to true after a group job has been created<br/><br/>Optional: Omit to retain current value
  - `linkedJobsVehicleId` integer, nullable — The unique identifier of the vehicle used for each job if linked<br/><br/>Cannot be set if AreJobsLinked is false<br/><br/>Cannot be set if the job group status is not scheduled or unscheduled<br/>Must be provided if ResourceId is provided<br/><br/>Optional: Omit to retain current value or provide null to unset
  - `linkedJobsResourceId` integer, nullable — The unique identifier of the resource used for each job if linked<br/><br/>Cannot be set if AreJobsLinked is false<br/><br/>Cannot be set if the job group status is not scheduled or unscheduled<br/>Must be provided if VehicleId is provided<br/><br/>Optional: Omit to retain current value or provide null to unset
  - `linkedJobsStartAt` string, date-time, nullable — The date and time the first job will be scheduled for if linked<br/><br/>Cannot be set if AreJobsLinked is false<br/><br/>Cannot be set if the job group status is not scheduled or unscheduled<br/><br/>Optional: Omit to retain current value or provide null to unset
  - `ownerId` integer, nullable — The unique identifier of the user who owns the job group<br/><br/>Setting to null removes the owner<br/><br/>Optional: Omit to retain current value or provide null to unset

## Response `204`

No Content

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `422` — Unprocessable Content
- `500` — Internal Server Error

---

[API](https://skmtc.net/bigchange/apis/bigchange-dx.md) · [All operations](https://skmtc.net/bigchange/apis/bigchange-dx/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bigchange/bigchange-dx/revisions/916e669fc527/schema)