Check the status of a file access update task

Last updated October 5, 2020

GET /filemanager/api/v3/files/set-access/:taskId/status

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing & CRM

Required Scope:

files

Check the status of a batch file access update task. You'll need the ID of a previously started batch update; see the documentation for more details.

Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header
or hapikey={key} query parameter.
Used to authenticate the request. Please see this page for more details about authentication.
Task ID :taskId
Used in the request URL
The ID of a previously started batch update task. This ID will be in the response when using the endpoint documented here.

The response will include the status of the update.

Status Description
ENQUEUED The task has been added to the queue and is waiting to be processed
STARTED The task has been started and is currently being processed.
COMPLETED The task has completed successfully.
PARTIAL_FAILURE The task has finished, but some files may not have updated successfully.

An error report can be retrieved from the URL in the the additional field ErrorTranscriptUrl.