Rename Folder Or Subfolder

Rename Folder Or Subfolder

Update the name of a specific DOC Vault folder or subfolder by providing its unique identifier (UUID).


HTTP Method and URL

PUT {{host}}/api/v2/vault/items/:uuid?name=sample rename&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 vault item to rename.

  • name (query, required): New name for the vault item.

  • user_type (query, required): User type (e.g., ENTERPRISE_API).


Request Body

This endpoint does not require a request body.


Example Request

PUT {{host}}/api/v2/vault/items/123e4567-e89b-12d3-a456-426614174000?name=NewFolderName&user_type=ENTERPRISE_API
Authorization: Bearer <your_token>

Example Successful Response

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "name": "NewFolderName",
  "user_type": "ENTERPRISE_API",
  "status": "success"
}

Error Responses

  • 400 Bad Request: Missing or invalid parameters.

  • 401 Unauthorized: Authentication failed or missing token.

  • 404 Not Found: Vault item with the specified UUID does not exist.

  • 409 Conflict: Name already in use.


Usage Notes

  • Ensure the uuid provided exists and is accessible to your user account.

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

  • No request body is required; all data is passed via path and query parameters.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Query Params
string
string
Response

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!