---
title: "Create User"
method: POST
path: "/users"
tags: ["Users / Entity"]
---

# Create User

`POST /users`

## Request

- Base URL: `https://api.forcemanager.com/api/v4`
- URL: `https://api.forcemanager.com/api/v4/users`
- Auth: API key in header `X-Session-Key`

This endpoint allows you to create a User based on JSON input.

You will only be able to create a User after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).

**HEADERS**

| **Parameter** | **Value** | **Description** |
| --- | --- | --- |
| Content-Type | application/json | Language in which all request and response bodies are encoded |
| Accept | \*/\* | Any data of whatever mime type is accepted |
| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |

**REQUEST**

| **Attribute** | **Type** | **Description** |
| --- | --- | --- |
| isActive | Boolean | If true, the User is activated. It is visible and can login in the apps |
| billable | Boolean | If true, the User is billable. ForceManager charges a fee for the user |
| branches (*Required*) | Array | Branches to which the User belongs to (see [Branches](#) resource) |
| branchRestriction | Boolean | If true, the user has limited visibility in some branches |
| computeSfm | Boolean | If true, the User counts for the sales analytics |
| email (*Required*) | String | User's email |
| extId | String | External ID of the User from a third party system (ERP, CRM, Accounting System) |
| id | Integer | The unique identifier of the User in ForceManager |
| lastName (*Required*) | String | User's last name |
| lastPasswordChangeDate | String | Date when the password was last changed |
| level | Integer | Permission level of the User. Set from 1 to 5 being 5 the highest level of permission and visibility |
| managerId | Integer | Unique identifier of the parent of the User (see [Users](#) resource) |
| name (*Required*) | String | User's first name |
| nic (*Required*) | String | User's name in ForceManager |
| phone (*Required*) | String | User's phone number |
| idPrefix (*Required*) | Integer | User's phone number Country ID (see [Countries](#) resource) |
| phoneExtension | String | User's phone number extension |
| rateId | Integer | Rate for the Order Header (see [Rates](#) resource) |
| session | Object, Null | If true, the User has access to the app |
| locale | String | The User locale. The values can be: "ES", "EN", "US", "IT", "DE", "PT", "BR", "RU" |
| dbLanguage (*Required*) | String | The User database language. The values can be: "ES", "EN", "US", "IT", "DE", "PT", "BR", "RU" |
| uiLanguage (*Required*) | String | The User UI language (the language in the mobile apps and webapp). The values can be: "ES", "EN", "US", "IT", "DE", "PT", "BR", "RU" |
| userType | Integer | Type of the User (see [Types](#) resource) |

**RESPONSE**

Returns a JSON with information about the User just created.

| **Attribute** | **Type** |
| --- | --- |
| Id | Id assigned to the new User |
| Message | The operation status |

**RESPONSE CODES**

| **Status** | **Description** |
| --- | --- |
| 200 OK | Shows if operation succeeded |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |

## Headers

- `Accept` string
- `X-FM-Entity-Count` string

## Request body

- object
  - `extId` string
  - `isActive` boolean
  - `branches` integer
  - `userTypeId` integer
  - `level` integer
  - `name` string
  - `lastName` string
  - `email` string
  - `nic` string
  - `password` string
  - `phone` string
  - `phoneExtension` string
  - `idPrefix` integer
  - `managerId` integer
  - `rateId` integer
  - `computeSfm` boolean
  - `dbLanguage` string
  - `uiLanguage` string
  - `locale` string
  - `deleted` boolean

## Response `200`

Create User

---

[API](https://skmtc.dev/forcemanager/apis/sage-sales-management-public-api-documentation-for-developer.md) · [All operations](https://skmtc.dev/forcemanager/apis/sage-sales-management-public-api-documentation-for-developer/llms.txt) · [OpenAPI document](https://skmtc.dev/forcemanager/apis/sage-sales-management-public-api-documentation-for-developer/revisions/87db17204e2f?raw)