Documents / Folders
Create Folder
This endpoint allows you to create a Folder based on JSON input.
You will only be able to create a Folder 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 BODY
| Attribute | Type | Description |
|---|---|---|
| name (Required) | String | The Folder name |
| folderId (Required) | String | The ID of the folder it belongs. -1 if it's gonna be in the root level, otherwise the Folder ID that will contains this Folder |
| level | Integer | Defines the visibility of the Folder. Set from 1 to 5 being 5 the highest level of permission |
| restrictSucursales | Boolean | True if not all the environment can see this Folder, otherwise False |
RESPONSE
| Attribute | Type | Description |
|---|---|---|
| message | String | "Entity Created" if everything it's OK. Otherwise, the error message |
| id | Integer | The ID assigned to the Folder in the ForceManager Database |
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 |
post/documents/folders
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/documents/folders
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Request body
Response
Create Folder
Changes
No recorded changes to this operation across all 1 revision of this API.