Ctrl+K

Update a single file

Update a single file#

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#

Updates the properties of a file. Only one property may be updated at a time. To rename a file, use PATCH. Updates are applied asynchronously and may not immediately be reflected on a subsequent GET.

PUT /prototype/platform/files/{fileId}

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

PrototypeFile

true

Details about the PrototypeFile to update.

Body parameter example#

{
  "kind": "Document",
  "name": "Year-end review"
}

Code Samples#

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

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

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

import requests

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

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

print(r.json())

Returns#

200 - OK#

Returns a PrototypeFile object containing details about the updated PrototypeFile.

400 - Bad Request#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

401 - Unauthorized#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

403 - Forbidden#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

404 - Not Found#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

409 - Conflict#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

429 - Too Many Requests#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

500 - Internal Server Error#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

503 - Service Unavailable#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Example Responses#

{
  "container": "",
  "created": {
    "dateTime": "2019-10-28T15:03:27Z"
  },
  "id": "124efa2a142f472ba1ceab34ed18915f",
  "kind": "Document",
  "modified": {
    "dateTime": "2020-04-01T11:31:06Z"
  },
  "name": "1989 Year-End Summary",
  "state": "Active",
  "template": false,
  "type": "Document"
}

{
  "code": "400BadRequest",
  "message": "The request was unacceptable, often due to a missing or invalid parameter"
}

{
  "code": "401Unauthorized",
  "message": "No valid API token provided"
}

{
  "code": "403Forbidden",
  "message": "The API token does not have permissions to perform the request"
}

{
  "code": "404NotFound",
  "message": "The requested resource could not be found"
}

{
  "code": "409Conflict",
  "message": "The request conflicts with another request"
}

{
  "code": "429TooManyRequests",
  "message": "Too many requests have been made against the API in too short a time"
}

{
  "code": "500InternalServerError",
  "message": "The server encountered an unexpected condition that prevented it from fulfilling the request"
}

{
  "code": "503ServiceUnavailable",
  "message": "The server cannot handle the request due to a temporary overload or scheduled maintenance"
}