---
title: "Create a resource"
method: POST
path: "/v1/resources"
tags: ["Resources"]
---

# Create a resource

`POST /v1/resources`

Create a new resource (required scope resources:write)

## Headers

- `Customer-Id` integer, required

## Request body

- CreateResourceModel — Create the resource request model
  - `reference` string, nullable — The internal reference of the resource - should usually be unique
  - `name` string, required — The full name of the resource
  - `groupId` integer, required — The unique identifier of the resource's group
  - `mobile` string, nullable — The mobile telephone number of the resource
  - `maxTravelDistance` integer, nullable — The maximum number of kilometres the resource will travel from start location (as crow flies)
  - `fuelCard` string, nullable — The fuel card number associated to the resource
  - `businessKey` string, nullable — The number associated to the resources business key
  - `privateKey` string, nullable — The number associated to the resources private key
  - `tachoCard` string, nullable — The tachograph driver card number associated to the resource
  - `isTracked` boolean — Indicates whether tracking data should be collected for this resource
  - `isTrackedOutOfHours` boolean — Indicates whether out of working hour tracking data is private
  - `workingHours` WriteWorkingHourModel[], nullable — The resources working hours / shifts, expressed relative to `timeZoneId`
    - `dayOfWeek` 'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday', required — <p>Possible values:</p><ul><li><b>sunday</b></li><li><b>monday</b></li><li><b>tuesday</b></li><li><b>wednesday</b></li><li><b>thursday</b></li><li><b>friday</b></li><li><b>saturday</b></li></ul>
    - `start` string, time, required — The 24H format time of day that the resource starts their shift (hh:mm)
    - `stop` string, time, required — The 24H format time of day that the resource stops their shift (hh:mm)
    - `startAtContactId` integer, nullable — The unique identifier of the contact (location) that the resource starts this shift from
  - `customFields` CustomFieldWriteModel[], nullable — Custom fields associated with the resource
    - `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

## 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)