Document Platform

Batch archive documents and folders. Selections that include a folder (or exceed the inline threshold) start a Temporal workflow and return 202 + workflowId; poll /archive/:workflowId/status.

post/customers/{customerId}/buildings/{buildingId}/documents-and-folders/batch/archive

Request

  • Base URL: http://localhost:9000
  • URL: http://localhost:9000/customers/{customerId}/buildings/{buildingId}/documents-and-folders/batch/archive
  • Auth: API key in header x-api-key

Path parameters

customerIdstring uuid required
buildingIdstring uuid required

Request body

documentIdsstring[] required
folderIdsstring[] required

Response

Default Response

successboolean required
messagestring required
workflowIdstring required

Changes

No recorded changes to this operation across all 1 revision of this API.