Reapply filters to the document#
Description#
Performs a DocumentFiltersReapplication on the specified document.
This endpoint is used to refresh the document’s filters based on the latest state or configuration changes.
The filters are reapplied in the context of the document’s current data state.
This is a long-running operation. Responses include a Location header, which indicates where to poll for results.
For more details on long-running job polling, see Operations endpoint.
POST /documents/{documentId}/filters/reapplication
Required OAuth Scopes
file:write
Parameters#
Parameter |
In |
Type |
Required |
Description |
|---|---|---|---|---|
X-Version |
header |
string |
true |
Version of the API (2026-01-01) |
documentId |
path |
string |
true |
The unique identifier of the document |
body |
body |
true |
The filter reapplication request to apply |
Body parameter example#
{
"forceHideFootnotes": true,
"ignoreNonEditableFilters": true
}
Code Samples#
curl -X POST https://api.app.wdesk.com/documents/{documentId}/filters/reapplication \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'X-Version: 2026-01-01'
http POST https://api.app.wdesk.com/documents/{documentId}/filters/reapplication \
X-Version:2026-01-01 \
Content-Type:application/json \
Accept:application/json \
Authorization:"Bearer {access-token}"
wget --method=POST "https://api.app.wdesk.com/documents/{documentId}/filters/reapplication" \
--output-document - \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}' \
--header 'X-Version: 2026-01-01'
import requests
headers = {
'X-Version': '2026-01-01',
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.app.wdesk.com/documents/{documentId}/filters/reapplication', headers = headers)
print(r.headers['Location'])
Returns#
202 - Accepted#
Header |
Description |
|---|---|
Location |
The location to poll for the operation result. |
Retry-After |
The number of seconds to wait before polling for a result and between polling attempts. |
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.
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.
Example Responses#
{
"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"
}