This call is deprecated. We recommend to use Account Administration API instead.
The corresponding new call is: POST /v1/user and other similar calls (PATCH /v1/user/password, PATCH /v1/user/pin, POST /v1/user/{userId}/warehouse).
Create or update a user. See the getUserRights with userID field for user data and rights retrieving. Newly created user will have access to all warehouses, if some specific list is of warehouses is required for user it can be specified using warehouseIDs
parameter (will replace existing list of access rights).
This API call may return error 1061 or 1062 (if you do not have the right to add/edit users) or 1066 (if you do not have the right to manage users in that specific user group).
Parameter name | Description | Possible value | Required |
---|---|---|---|
userID | integer | ||
lang | Retrieve item names in a specific language. If omitted, API will return item names in the default language of your Erply account. Possible values:
|
string | |
userGroupID | User group. Required field when creating a new user. |
integer | |
name | Employee's username. Required field when creating a new user. Each user must have a unique name. API returns error 1012 if you try to create a user with a name that already exists. |
string | |
password | Employee's password. Password must be at least 8 characters, otherwise API returns error 1016. | string | |
cardCode | User PIN. PIN must be at least 6 characters, otherwise API returns error 1016. | string | |
employeeID | ID of the employee. | integer | |
warehouseIDs | List of warehouse IDs to give access for user | String (A comma-separated list of integers.) | |
sendNotificationEmail | 0 or 1, by default 0 | integer |
Field name | Type | Description |
---|---|---|
userID | integer | ID of the newly-created or updated item |