Initiate a file export by ID

Deprecated

This endpoint is deprecated and may be removed in a future release.

This endpoint was deprecated on 2026-02-12.

It is scheduled for sunset on 2027-01-31.

Description#

Export a file by its unique ID. This is a long running operation. Responses include a Location header, which indicates where to poll for export results. For more details on long-running job polling, see Operations endpoint. When the export process is complete, the status of the Operation will change to completed. The resourceUrl field of the operation will contain the download url of the exported file. To download the file, perform a GET against the resourceUrl with the same authentication credentials and flow as the export request. For more details, see Authentication documentation. For more on Document, LegacySpreadsheet, and Presentation export options, see the following: Documents, PlatformSpreadsheets, and Presentations.

POST /prototype/platform/files/{fileId}/export

Required OAuth Scopes

file:write

Parameters#

Parameter	In	Type	Required	Description
X-Version	header	string	false	Version of the API (2022-01-01)
fileId	path	string	true	The unique identifier of the file
body	body	PrototypeFileExportById	true	The details of the file export.

Body parameter example#

{
  "kind": "SupportingDocument"
}

Code Samples#

curl

curl -X POST https://api.app.wdesk.com/prototype/platform/files/{fileId}/export \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2022-01-01'

httpie

http POST https://api.app.wdesk.com/prototype/platform/files/{fileId}/export \
    X-Version:2022-01-01 \
    Content-Type:application/json \
    Accept:application/json \
    Authorization:"Bearer {access-token}"

wget

wget --method=POST "https://api.app.wdesk.com/prototype/platform/files/{fileId}/export" \
    --output-document -  \ 
    --header 'Content-Type: application/json' \ 
    --header 'Accept: application/json' \ 
    --header 'Authorization: Bearer {access-token}' \
    --header 'X-Version: 2022-01-01'

python

import requests

headers = {
  'X-Version': '2022-01-01',
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.app.wdesk.com/prototype/platform/files/{fileId}/export', headers = headers)

print(r.headers['Location'])