跳到主要内容

markAsRead

FileOperationArrayWrapper markAsRead(BaseBatchRequestDto)

PUT /api/2.0/files/fileops/markasread

Mark files and folders as read

Queues a background job that clears the new-item badge from the requested files and folders for the calling account, and answers with the caller's mark-as-read operations, including the one just started. Poll GET api/2.0/files/fileops until the operation reports finished. Marking a folder clears the badges of everything inside it as well. Items the caller cannot read are passed over in silence rather than refused, so the call succeeds even when the whole selection is inaccessible, and an empty selection queues nothing and answers with the operations that are already there. Repeating the call on items that are already read changes nothing, and nothing is opened, moved or modified by it — only the caller's own badges are affected, while other members keep theirs. To see what is currently marked as new use GET api/2.0/files/{folderId}/news for one folder and GET api/2.0/files/rooms/news for the rooms of the caller.

Parameters​

NameInTypeDescriptionNotes
BaseBatchRequestDtobodyBaseBatchRequestDto[optional]

Responses​

Status codeDescriptionTypeResponse headers
200The mark-as-read operations of the caller, the one just queued includedFileOperationArrayWrapperX-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset
500An id is a number that is not a 32-bit integer--
401UnauthorizedErrorApiResponse-
429Too Many Requests.ErrorApiResponseRetry-After
400Bad Request.ErrorApiResponse-
502Bad Gateway. Returned by the reverse proxy, response body may be HTML and not JSON.--
503Service Unavailable. Returned by the reverse proxy, response body may be HTML and not JSON.--

Return type​

FileOperationArrayWrapper

Authorization​

Basic, OAuth2 (scopes: read, write), ApiKeyBearer, asc_auth_key, Bearer, OpenId

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json