Skip to navigation

Export Item

This endpoint launches a long-running task and returns the Task ID of the launched task. The task response contains a link to download the exported item from Amazon S3. The download is a ZIP file that contains the exported content in the requested format (PDF or HTML). This endpoint is subject to throughput rate limiting. Due to the long running nature of these export requests, the endpoint may reject the request with an HTTP 429 error if the system is currently handling too many export requests simultaneously. Note that the rate limit is not a fixed limit based on number of requests per hour, but rather a dynamic limit based on current system load and complexity of the items being exported. If using this endpoint with a large number of requests, it is recommended to implement a backoff and retry strategy to handle HTTP 429 errors. In rare cases, attachments still being scanned for viruses are omitted from the export.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
idstringRequired
ID of the item to export
formatenumOptionalDefaults to pdf
The export format for the item. Defaults to pdf if not specified.
Allowed values:

Response

This endpoint launches a long-running task and returns the Task ID of the launched task. The task response contains a link to download the exported item from Amazon S3. The download is a ZIP file that contains the exported content in the requested format (PDF or HTML).

taskIdstringOptional

Errors

400
Bad Request Error