---
title: "Create a user"
method: POST
path: "/v1/users"
tags: ["Users"]
---

# Create a user

`POST /v1/users`

Create a new user (required scope users:write)

## Headers

- `Customer-Id` integer, required

## Request body

- CreateUserModel — Represents a model for creating a user
  - `name` string, required — The name associated with the user
  - `email` string, required — The email associated with the user
  - `roleId` integer, required — The role ID associated with the user
  - `defaultJobCategoryId` integer, nullable — The default job category ID associated with the user
  - `position` string, nullable — The job position or title associated with the user
  - `type` 'active' | 'inactive' | 'linkedResource' — Represents the type of licence assigned to a user<p>Possible values:</p><ul><li><b>active</b>: Indicates an active licence</li><li><b>inactive</b>: Indicates an inactive licence</li><li><b>linkedResource</b>: Indicates a licence associated with a linked resource</li></ul>
  - `groupId` integer, nullable — The group identifier associated with the user
  - `mobile` string, nullable — The mobile phone number associated with the user. The phone number has to start with a + sign followed by the country code, followed by the number without the first zero
  - `customFields` CustomFieldWriteModel[], nullable — Custom fields associated with the user
    - `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)