Roles
Delete Roles in User
This endpoint allows you to delete a specific User's Role from the user's ForceManager account database. If the specified User's Role does not exist, the response will be a "bad request". This operation cannot be undone.
You will only be able to delete an User's Role after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication. [ HEADERS
| Parameter | Type | Description |
|---|---|---|
| Content-Type | application/json | Language in which all request and response bodies are encoded |
| Accept | */* | The acceptance |
| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |
| ]: <> |
| Parameter | Type | Description |
|---|---|---|
| rolesId | Object | Array of the Roles Id that you want to delete for a specific User |
Returns a JSON with information with the updated User's Roles.
| Attribute | Type | Description |
|---|---|---|
| branches | Object, Null | Branch to which the User has been assigned |
| dateCreated | String | Date and time when the User's Role was associated |
| dateDeleted | String | Date and time when the User's Role was deleted |
| dateUpdated | String | Date and time when the User's Role was udpated |
| deleted | Boolean | If true, the User's Role has been deleted and archived |
| extId | String | External ID of the Role from a third party system (ERP, CRM, Accounting System) |
| id | Integer | The unique identifier of the Role in ForceManager |
| level | Boolean | If true, the User is billable. ForceManager charges a fee for the user |
| name | String | The Role name |
| salesRepIdCreated | Integer | Unique identifier of the user who associated the Role |
| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Role |
| salesRepIdUpdated | Integer | Unique identifier of the user who updated the Role |
| Status | Description |
|---|---|
| 200 OK | Shows if operation succeeded |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |
delete/users/{ID}/roles
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/users/{ID}/roles
- Auth: API key in header X-Session-Key
Headers
Acceptstring
X-FM-Entity-Countstring
Response
Delete Roles in User
Changes
No recorded changes to this operation across all 1 revision of this API.