Users / Types
Create User Type
This endpoint allows you to create a User Type based on JSON input.
You will only be able to create a User Type 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
| Parameter | Type | Description |
|---|---|---|
| branchVisibility | Array | In which Branch the User Type is visible |
| descriptionBR | String | User Type label in Brasilian Portuguese |
| descriptionDE | String | User Type label in German |
| descriptionDK | String | User Type label in Dutch |
| descriptionEN (Required) | String | User Type label in English |
| descriptionES | String | User Type label in Spanish |
| descriptionFR | String | User Type label in French |
| descriptionIT | String | User Type label in Italian |
| descriptionPT | String | User Type label in Portuguese |
| descriptionRU | String | User Type label in Russian |
| descriptionUS | String | User Type label in American English |
| order | Integer | The position of the User Type in the User Types value list |
RESPONSE
Returns a JSON with information about the User Type just created.
| Attribute | Type |
|---|---|
| Id | Id assigned to the new User Type |
| Message | The operation status |
| Status | Description |
|---|---|
| 200 OK | Shows if operation succeeded |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |
post/userTypes
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/userTypes
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Request body
Response
Create User Type
Changes
No recorded changes to this operation across all 1 revision of this API.