---
title: "Create a job group"
method: POST
path: "/v1/jobGroups"
tags: ["JobGroups"]
---

# Create a job group

`POST /v1/jobGroups`

Create a new job group (required scope jobs:write)

## Headers

- `Customer-Id` integer, required

## Request body

- CreateJobGroupModel — Create job group request model
  - `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
  - `contactId` integer — The unique identifier of the contact the job group is for
  - `personId` string, uuid, nullable — The unique uuid identifier of the person who will serve as primary point of contact for the job
  - `title` string, nullable — The title of the job group
  - `isShownOnDevice` boolean — Indicates whether the job group is shown on the device. If true, it will be shown
  - `areJobsLinked` boolean — Indicates whether the jobs in the group are linked
  - `orderNumber` string, nullable — The order number associated with the job group
  - `plannedStartOption` 'onSetDate' | 'dateOfFirstJob', required — 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 BigChange.BO.RestApi.Application.JobGroups.Models.CreateJobGroupModel.PlannedStartOption is BigChange.BO.RestApi.Application.JobGroups.Enumerations.JobGroupPlannedStartOptions.OnSetDate
  - `plannedEndOption` 'onSetDate' | 'dateOfLastJob', required — 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 BigChange.BO.RestApi.Application.JobGroups.Models.CreateJobGroupModel.PlannedEndOption is BigChange.BO.RestApi.Application.JobGroups.Enumerations.JobGroupPlannedEndOptions.OnSetDate
  - `categoryId` integer, nullable — The unique identifier of the category that the job group is assigned to
  - `linkedJobsResourceId` integer, nullable — The unique identifier of the resource who will be actioning the job group. Should return an error if the BigChange.BO.RestApi.Application.JobGroups.Models.CreateJobGroupModel.AreJobsLinked is `false`
  - `linkedJobsStartAt` string, date-time, nullable — The UTC timestamp for when the job group is started. Should return an error if the BigChange.BO.RestApi.Application.JobGroups.Models.CreateJobGroupModel.AreJobsLinked is `false`
  - `linkedJobsVehicleId` integer, nullable — The unique identifier of the vehicle associated with the job group. Should return an error if the BigChange.BO.RestApi.Application.JobGroups.Models.CreateJobGroupModel.AreJobsLinked is `false`
  - `ownerId` integer, nullable — The unique identifier of the user who owns the job group

## Response `201`

Created

- PostResponseInt64 — Represents a response for a POST request, containing the ID of the newly created record
  - `id` integer — Identifier of the newly created record

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `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)