Team Folder Archive Check

POST

https://api.dropboxapi.com/2/team/team_folder/archive/check

Returns the status of an asynchronous job for archiving a team folder.

The job may show ‘.tag’ as complete, but the team folder could still be in the process of archiving (indicated by TeamFolderMetadata.status with ‘archive_in_progress’).

To confirm that the team folder is fully archived, check the field TeamFolderMetadata.status in the response for the value ‘archived’.

Permission : Team member file access.

Required scope: team_data.content.write

Endpoint format: RPC

Authentication: Team

Returns the status of an asynchronous job for archiving a team folder. The job may show '.tag' as complete, but the team folder could still be in the process of archiving (indicated by `TeamFolderMetadata.status` with 'archive_in_progress'). To confirm that the team folder is fully archived, check the field `TeamFolderMetadata.status` in the response for the value 'archived'. Permission : Team member file access. **Required scope:** `team_data.content.write` **Endpoint format:** [RPC](https://docs.dropboxapi.com/dropbox-api/docs/technical-reference/request-response-formats#rpc-endpoints) **Authentication:** [Team](https://docs.dropboxapi.com/dropbox-api/docs/auth-types#team-authentication)

Authentication

AuthorizationBearer

Team-level OAuth 2.0 token issued to a Dropbox Business admin. Use Authorization: Bearer <token>.

Obtain via the authorization code flow with team-scoped permissions.

Grants access to team-wide administrative operations.

You can generate a short-lived access token from the App Console; see Testing with a generated token.

Team-level OAuth 2.0 token issued to a Dropbox Business admin. Use `Authorization: Bearer <token>`. Obtain via the authorization code flow with team-scoped permissions. Grants access to team-wide administrative operations. You can generate a short-lived access token from the App Console; see [Testing with a generated token](https://docs.dropboxapi.com/dropbox-api/docs/oauth#testing-with-a-generated-token).

Request

This endpoint expects an object.

async_job_idstringRequired>=1 character

Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Response headers

X-Dropbox-Request-IdstringOptional

A unique identifier for the request, useful for debugging and support.

Response

Successful response

Variant:

team.TeamFolderArchiveJobStatus.in_progressobject

The asynchronous job is still in progress.

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error