Users / Entity
Update User
This endpoint allows you to update a specific User. If the specified User does not exist, the response will be a "bad request".
You will only be able to update a User after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication.
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
This endpoint allows updating the information of a specific User. In order to update a User, you just have to specify the attributes you want to modify and complete with the up to date information. It is not necessary to send all attributes.
| 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 | 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 |
| 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 | 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 | String | User's first name |
| nic | String | User's name in ForceManager |
| phone | String | User's phone number |
| idPrefix | 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 | String | The User database language. The values can be: "ES", "EN", "US", "IT", "DE", "PT", "BR", "RU" |
| uiLanguage | 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 updated.
| Attribute | Description |
|---|---|
| Message | Shows 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 |
put/users/{ID}
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/users/{ID}
- Auth: API key in header X-Session-Key
Headers
Acceptstring
X-FM-Entity-Countstring
Request body
Response
Update User
Changes
No recorded changes to this operation across all 1 revision of this API.