Move Document Into Folder Or Subfolder
Moves a specific document in the DOC Vault into a folder or subfolder by providing the destination folder's unique identifier.
HTTP Method and URL
POST {{host}}/api/v2/vault/items/:uuid/move?folder_uuid&user_type=ENTERPRISE_API
Authentication Requirements
Requires valid authentication. Ensure your API token or credentials are included as per your environment setup.
Path and Query Parameters
-
uuid(path, required): Unique identifier of the document to be moved. -
folder_uuid(query, required): Unique identifier of the folder where the document will be moved. -
user_type(query, required): Type of user making the request (e.g.,ENTERPRISE_API).
Request Body
No request body is required; all data is passed via path and query parameters.
Example Request
httpPOST {{host}}/api/v2/vault/items/ 123e4567-e89b-12d3-a456-426614174000/ move? folder_uuid=987f6543-e21b-45c6-b789-123 456789abc&user_type=ENTERPRISE_APIAuthorization: Bearer <your_token>
Example Successful Response
json{ "status": "success", "message": "Document moved successfully.", "document_uuid": "123e4567-e89b-12d3-a456-4266141740 00", "folder_uuid": "987f6543-e21b-45c6-b789-123456789a bc"}
Error Responses
-
400 Bad Request: Missing or invalid parameters.
-
401 Unauthorized: Authentication failed or missing token.
-
404 Not Found: Document or folder with the specified UUID does not exist.
-
409 Conflict: Document already exists in the target folder.
Usage Notes
-
Ensure the
uuidandfolder_uuidprovided exist and are accessible to your user account. -
No request body is required; all data is passed via path and query parameters.
-
The
user_typeparameter is typically set toENTERPRISE_API.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
