Skip to content
Ishvana Ishvana Docs

Bulk Move Documents

POST
/api/writing/documents/bulk-move

📦 Bulk move documents.

Moves multiple documents to a folder.

Args: document_ids: List of document IDs to move service: Injected DocumentCategoriesService instance folder_id: Target folder ID (None for root)

Returns: WritingBulkMoveResponse: Bulk move result with count

Raises: HTTPException 400: If target folder not found HTTPException 500: If bulk move fails

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
folder_id
Any of:
string

Target folder ID (None for root)

Request Body required

Section titled “Request Body required ”
Document Ids
Array<string>

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

WritingBulkMoveResponse

Response model for bulk document move operations in Writing Studio.

Confirms successful bulk move with count of documents moved. Used for multi-document folder organization operations.

Fields:

  • success: Whether the bulk move operation succeeded
  • moved_count: Number of documents successfully moved
  • folder_id: Target folder ID (null for root)
  • timestamp: ISO 8601 timestamp of the operation

Usage: POST /api/creative/categories/documents/bulk-move returns this model.

JSON Example:

{
  "success": true,
  "movedCount": 5,
  "folderId": "folder_xyz",
  "timestamp": "2025-12-04T10:30:00Z"
}
object
success
required
Success

Bulk move success status

boolean
movedCount
required
Movedcount

Number of documents moved

integer
folderId
Any of:
string
timestamp
required
Timestamp

Operation timestamp (ISO 8601)

string

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object