---
title: "Create a job"
method: POST
path: "/v1/jobs"
tags: ["Jobs"]
---

# Create a job

`POST /v1/jobs`

## Request

- Base URL: `https://api.bigchange.com`
- URL: `https://api.bigchange.com/v1/jobs`
- Auth: HTTP bearer

Create a new job. A job can be added to any job group, except a job group marked Financially Complete (required scope jobs:write)

## Headers

- `Customer-Id` integer, required

## Request body

- CreateJobModel: Represents a model that holds information about creating a job
  - `typeId` integer, required: The unique identifier of the type assigned to this job
  - `contactId` integer, required: The unique identifier of the contact (customer) for who this job is to be performed
  - `plannedDuration` integer, nullable: The planned duration for the job, indicated in minutes. If not provided, the default duration for the job type will be used
  - `reference` string, nullable: The internal reference of the job - should usually be unique. If not provided and job type auto-reference set, auto-referenced value will be used
  - `description` string, nullable: The textual details about the job
  - `personId` string, uuid, nullable: The unique uuid identifier of the person who will serve as primary point of contact for the job
  - `orderNumber` string, nullable: The order number associated to the job. May be required, dependent upon job type
  - `jobGroupId` integer, nullable: The unique identifier of the job group to which this job belongs
  - `categoryId` integer, nullable: The unique identifier of the category that the job is assigned to
  - `customFields` CustomFieldWriteModel[]: Custom fields applied to this job
    - `definitionId` integer, required: The unique identifier of the associated custom field definition
    - `value` string, nullable: The value of this custom field. If set to null, any existing value will be unset
  - `siteContactId` integer, nullable: The unique identifier of the site contact for this job<br/>If provided, the contact must exist within the customer's account

## 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.dev/bigchange/apis/bigchange-dx.md) - [All operations](https://skmtc.dev/bigchange/apis/bigchange-dx/llms.txt) - [OpenAPI document](https://skmtc.dev/bigchange/apis/bigchange-dx/revisions/b262bfdb1dd0?raw)
