Create Subfolder

Creates a DOC Vault subfolder within a specified parent folder. Use this endpoint to organize or move completed documents into subfolders for better management.

HTTP Method and URL

POST {{host}}/api/v2/folders/:uuid/sub?name&user_type=ENTERPRISE_API

• :uuid (path variable): The unique identifier of the parent folder where the subfolder will be created.

Authentication Requirements

Requires valid authentication. Ensure your API token or credentials are included as per your environment setup.

Path and Query Parameters

• uuid (string, path): Unique ID of the parent folder. Required.

• name (string, query): Name of the subfolder to create. Required.

• user_type (string, query): Type of user creating the subfolder. Example: ENTERPRISE_API. Required.

Request Body

No request body is required for this endpoint.

Example Request

POST {{host}}/api/v2/folders/123e4567-e89b-12d3-a456-426614174000/sub?name=Invoices&user_type=ENTERPRISE_API
Authorization: Bearer <your_token>

Example Successful Response

{
  "id": "456e7890-e12b-34d5-b678-526614174111",
  "name": "Invoices",
  "parent_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2024-06-01T12:00:00Z"
}

Error Responses

• 400 Bad Request: Missing or invalid parameters.

• 401 Unauthorized: Authentication failed or missing token.

• 404 Not Found: Parent folder not found.

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

Usage Notes

• Ensure the uuid provided exists and you have permission to create subfolders within it.

• The name parameter must be unique within the parent folder.

• This endpoint does not accept a request body; all parameters are passed via the URL.