Create Folder

Creates a new folder in DOC Vault to help users organize their completed documents. The maximum number of folders allowed depends on the user's plan. There is no limit to the number of files that can be stored in a folder.

HTTP Method and URL

POST {{host}}/api/v2/folders?name={folderName}&user_type=USERTYPE

Authentication Requirements

Requires a valid user-token provided as a variable in the environment or as a header.

Query Parameters

• name (string, required): The name of the folder to be created.

• user_type (string, required): The type of user (e.g., ENTERPRISE_API).

Request Body

No request body is required for this endpoint. All parameters are passed as query parameters.

Example Request

POST {{host}}/api/v2/folders?name=testfile&user_type=ENTERPRISE_API
Headers:
  user-token: <your_token>

Example Successful Response

{
  "id": "string",
  "name": "testfile",
  "created_at": "2024-06-01T12:00:00Z",
  "user_type": "ENTERPRISE_API"
}

Error Responses

• 400 Bad Request: Missing or invalid parameters.

• 401 Unauthorized: Authentication failed or missing token.

• 409 Conflict: Folder with the same name already exists.

• 429 Too Many Requests: Folder creation limit reached for the user plan.

Usage Notes

• Ensure the user-token variable is set in your environment.

• Folder names must be unique per user.

• The number of folders you can create depends on your subscription plan.