Partially update a single section#

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 2029-01-31.

Description#

Partially updates the properties of a section.

Options#

Path	PATCH Operations Supported
`/name`	`replace`
`/index`	`replace`
`/parent`	`replace`

Examples#

Update the name of a section#

[
  {
    "op": "replace",
    "path": "/name",
    "value": "Introduction"
  }
]

Update the parent of a section (preserving its index)#

[
  {
    "op": "replace",
    "path": "/parent",
    "value": {
      "id": "b9b3ddb587744a27aafda3c9865f1f0a_1"
    }
  }
]

Update the parent of a section (making it the first child)#

[
  {
    "op": "replace",
    "path": "/parent",
    "value": {
      "id": "b9b3ddb587744a27aafda3c9865f1f0a_1"
    }
  },
  {
    "op": "replace",
    "path": "/index",
    "value": 0
  }
]

PATCH /platform/v1/documents/{documentId}/sections/{sectionId}

Required OAuth Scopes

file:write

Parameters#

Parameter	In	Type	Required	Description
X-Version	header	string	false	Version of the API (2022-01-01)
documentId	path	string	true	The unique identifier of the document
sectionId	path	string	true	The unique identifier of the section
body	body	JSONPatchDocument	true	A collection of patch operations to apply to the section.

Body parameter example#

[
  {
    "op": "replace",
    "path": "/name",
    "value": "New Name"
  }
]

Code Samples#

curl

curl -X PATCH https://api.app.wdesk.com/platform/v1/documents/{documentId}/sections/{sectionId} \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2022-01-01'

httpie

http PATCH https://api.app.wdesk.com/platform/v1/documents/{documentId}/sections/{sectionId} \
    X-Version:2022-01-01 \
    Content-Type:application/json \
    Accept:application/json \
    Authorization:"Bearer {access-token}"

wget

wget --method=PATCH "https://api.app.wdesk.com/platform/v1/documents/{documentId}/sections/{sectionId}" \
    --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.patch('https://api.app.wdesk.com/platform/v1/documents/{documentId}/sections/{sectionId}', headers = headers)

print(r.json())