Batch update a list of SectionXbrlProperties by Section IDs

Description

Batch updates a list of SectionXbrlProperties using Section IDs and returns a list of the successfully updated SectionXbrlProperties.

Options

Path	PATCH Operations Supported	Value Type
/xbrlDisabled	replace	boolean

Responds with a bad request error for the following scenarios:

• The data array is not provided or empty.

• The data array contains duplicate section IDs.

• The request contains more than 200 updates.

• A SectionXbrlPropertiesUpdate.patch contains no operations, conflicting operations, or an unsupported operation.

POST /documents/{documentId}/xbrlProfiles/{xbrlProfileId}/sections/batchUpdate

Required OAuth Scopes

file:write

Parameters

Parameter	In	Type	Required	Description
X-Version	header	string	true	Version of the API (2026-08-01.xbrl.preview)
documentId	path	string	true	The unique identifier of the document
xbrlProfileId	path	string	true	The unique identifier of the XBRL profile
body	body	BatchUpdateSectionXbrlPropertiesRequest	true

Body parameter example

{
  "data": [
    {
      "patch": [
        {
          "op": "replace",
          "path": "/xbrlDisabled",
          "value": true
        }
      ],
      "section": "257a1db8080749c6887338495b929248"
    }
  ]
}

Code Samples

curl

curl -X POST https://api.app.wdesk.com/documents/{documentId}/xbrlProfiles/{xbrlProfileId}/sections/batchUpdate \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2026-08-01.xbrl.preview'

httpie

http POST https://api.app.wdesk.com/documents/{documentId}/xbrlProfiles/{xbrlProfileId}/sections/batchUpdate \
    X-Version:2026-08-01.xbrl.preview \
    Content-Type:application/json \
    Accept:application/json \
    Authorization:"Bearer {access-token}"

wget

wget --method=POST "https://api.app.wdesk.com/documents/{documentId}/xbrlProfiles/{xbrlProfileId}/sections/batchUpdate" \
    --output-document -  \ 
    --header 'Content-Type: application/json' \ 
    --header 'Accept: application/json' \ 
    --header 'Authorization: Bearer {access-token}' \
    --header 'X-Version: 2026-08-01.xbrl.preview'

python

import requests

headers = {
  'X-Version': '2026-08-01.xbrl.preview',
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.app.wdesk.com/documents/{documentId}/xbrlProfiles/{xbrlProfileId}/sections/batchUpdate', headers = headers)

print(r.json())

Returns

200 - OK

A resulting list of SectionXbrlProperties resources.

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.

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.

Example Responses

200 Response

{
  "data": [
    {
      "section": "257a1db8080749c6887338495b929248",
      "xbrlDisabled": true
    }
  ]
}

Bad Request

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

Unauthorized

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

Forbidden

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

Not Found

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

Too Many Requests

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