Document Platform

Prepare document download

Prepares a download for selected documents and/or folders. Returns either a direct download URL for small selections, or queues an async job and returns a message indicating the user will receive an email when ready.

post/customers/{customerId}/buildings/{buildingId}/documents/download/prepare

Request

  • Base URL: http://localhost:9000
  • URL: http://localhost:9000/customers/{customerId}/buildings/{buildingId}/documents/download/prepare
  • Auth: API key in header x-api-key

Path parameters

customerIdstring uuid required
buildingIdstring uuid required

Request body

OR

Response

Default Response

OR

Changes

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