---
title: "Add users"
method: POST
path: "/api/v4/users"
---

# Add users

`POST /api/v4/users`

This method allows to add multiple users to the account

## Headers

- `Content-Type` string

## Request body

- object
  - `RAW_BODY` object[]
    - `name` string, required — User fullname. The value should not contain special symbols (except .@-_), consist of spaces, contain links. It should be no longer than 50 symbols.
    - `email` string, required — User email
    - `password` string, required — User password. It should be no less than 6 symbols long and contain at least 1 digit, capital, and lower-case letter.
    - `lang` string — User language. One of the following: ru, en, es, pt. It is the account language (ru, en, es, or pt) by default.
    - `rights` object — User rights. The field is not mandatory, by default all access is restricted.
      - `leads` object — Leads access rights object. The field is mandatory if the “role_id” isn’t passed and the “is_free” flag isn’t set
        - `view` 'A' | 'G' | 'M' | 'D'
        - `edit` 'A' | 'G' | 'M' | 'D'
        - `add` 'A' | 'G' | 'M' | 'D'
        - `delete` 'A' | 'G' | 'M' | 'D'
        - `export` 'A' | 'G' | 'M' | 'D'
      - `contacts` object — Contacts access rights object. The field is mandatory if the “role_id” isn’t passed and the “is_free” flag isn’t set
        - `view` 'A' | 'G' | 'M' | 'D'
        - `edit` 'A' | 'G' | 'M' | 'D'
        - `add` 'A' | 'G' | 'M' | 'D'
        - `delete` 'A' | 'G' | 'M' | 'D'
        - `export` 'A' | 'G' | 'M' | 'D'
      - `companies` object — Companies access rights object. The field is mandatory if the “role_id” isn’t passed and the “is_free” flag isn’t set
        - `view` 'A' | 'G' | 'M' | 'D'
        - `edit` 'A' | 'G' | 'M' | 'D'
        - `add` 'A' | 'G' | 'M' | 'D'
        - `delete` 'A' | 'G' | 'M' | 'D'
        - `export` 'A' | 'G' | 'M' | 'D'
      - `tasks` object — Tasks access rights object. The field is mandatory if the “role_id” isn’t passed and the “is_free” flag isn’t set
        - `view` 'A' | 'G' | 'M' | 'D'
        - `edit` 'A' | 'G' | 'M' | 'D'
        - `add` 'A' | 'G' | 'M' | 'D'
        - `delete` 'A' | 'G' | 'M' | 'D'
        - `export` 'A' | 'G' | 'M' | 'D'
      - `status_rights` string, json — An array of the objects that define stages rights. It is null by default. If the fields rights[status_rights] with the value “null” is passed, the user will receive “restricted” rights for Incoming Leads stages.
      - `mail_access` boolean — Defines whether Mail functionality is allowed for the user. It is false by default.
      - `catalog_access` boolean — Defines whether Lists functionality is allowed for the user. It is false by default.
      - `is_free` boolean — Defines whether it is a free user. If the value “true” is passed into the “is_free” field then the values of the following fields will be ignored: rights[leads], rights[tasks], rights[contacts], rights[companies], rights[status_rights], rights[mail_access], rights[catalog_access], rights[role_id], rights[group_id].
      - `role_id` integer — ID of the user’s role. It is null by default. If a valid “role_id” value is passed then the values of the following fields will be ignored: rights[leads], rights[tasks], rights[contacts], rights[companies], rights[status_rights], rights[mail_access], rights[catalog_access].
      - `group_id` integer — ID of the user’s group. It is null by default. If the value “null” is passed into the rights[group_id] field, the user will be added to the default “Sales Office” group.
      - `request_id` string — Field that will be returned unchanged in the response and will not be saved

## Response `201`

Created

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/kommo/apis/kommo-api-references.md) · [All operations](https://skmtc.net/kommo/apis/kommo-api-references/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kommo/kommo-api-references/versions/f17af4d23c7c/schema)