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

← Team operations · Get started

Operation dropbox.team_team_folder_archive_check

Provider route: POST /2/team/team_folder/archive/check. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/dropbox with npm, or alter-sdk-dropbox with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DropboxIntegration } from "@alter-ai/dropbox";

async function execute(input: Parameters<DropboxIntegration["team"]["teamFolderArchiveCheck"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new DropboxIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.team.teamFolderArchiveCheck(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_dropbox import DropboxIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = DropboxIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.team.team_folder_archive_check(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
headers	object	Optional	Additional keys: not allowed
headers.Dropbox-API-Path-Root	Model	Optional	Expand Deletes a group — request body — headers Dropbox-API-Path-Root
headers.Dropbox-API-Select-User	string	Optional
headers.Dropbox-API-Select-Admin	string	Optional
body	Model	Required within parent	Expand Check the status of a save url job — request body — body

Referenced models: Check the status of a save url job — request body — body, Deletes a group — request body — headers Dropbox-API-Path-Root

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Returns the status of an asynchronous job for archiving a team folder — response body

Referenced models: Returns the status of an asynchronous job for archiving a team folder — response body

Schemas

2 more schemas are linked from the tables above, on the schema pages.

Check the status of a save url job — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Arguments for methods that poll the status of an asynchronous job.
async_job_id	string	Required within parent	Minimum length: 1

Deletes a group — request body — headers Dropbox-API-Path-Root

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	One of: home
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: home
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: root
$ (anyOf 3).root	string	Required within parent	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
$ (anyOf 4)	object	Alternative
$ (anyOf 4)..tag	string	Required within parent	Must equal: namespace_id
$ (anyOf 4).namespace_id	string	Required within parent	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
$ (anyOf 5)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 5)..tag	string	Required within parent	Pattern: ^(?!(?:home|root|namespace_id)$)

Returns the status of an asynchronous job for archiving a team folder — response body

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	Known values: in_progress
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: in_progress
$ (anyOf 3)	Model	Alternative	Expand Returns the status of an asynchronous job for archiving a team folder — response body — tag complete
$ (anyOf 4)	object	Alternative
$ (anyOf 4)..tag	string	Required within parent	Must equal: failed
$ (anyOf 4).failed	Model	Required within parent	Expand Returns the status of an asynchronous job for archiving a team folder — response body — tag failed failed

Referenced models: Returns the status of an asynchronous job for archiving a team folder — response body — tag failed failed, Returns the status of an asynchronous job for archiving a team folder — response body — tag complete

Returns the status of an asynchronous job for archiving a team folder — response body — tag failed failed

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative
$ (anyOf 1)..tag	string	Required within parent	Must equal: access_error
$ (anyOf 1).access_error	Model	Required within parent	Expand Returns the status of an asynchronous job for archiving a team folder — response body — tag failed failed tag access error access error
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: status_error
$ (anyOf 2).status_error	Model	Required within parent	Expand Returns the status of an asynchronous job for archiving a team folder — response body — tag failed failed tag status error status error
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: team_shared_dropbox_error
$ (anyOf 3).team_shared_dropbox_error	Model	Required within parent	Expand Returns the status of an asynchronous job for archiving a team folder — response body — tag failed failed tag team shared dropbox error team shared dropbox error
$ (anyOf 4)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tag	string	Required within parent	Pattern: ^(?!(?:access_error|status_error|team_shared_dropbox_error)$)

Referenced models: Returns the status of an asynchronous job for archiving a team folder — response body — tag failed failed tag access error access error, Returns the status of an asynchronous job for archiving a team folder — response body — tag failed failed tag status error status error, Returns the status of an asynchronous job for archiving a team folder — response body — tag failed failed tag team shared dropbox error team shared dropbox error

Returns the status of an asynchronous job for archiving a team folder — response body — tag complete

Field	Type	Presence	Description and constraints
$	object	Root
.tag	string	Required within parent	Must equal: complete
team_folder_id	string	Required within parent	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
name	string	Required within parent
status	Model	Required within parent	Expand Changes an active team folder's name — response body — status
is_team_shared_dropbox	boolean	Required within parent
sync_setting	Model	Required within parent	Expand Changes an active team folder's name — response body — sync setting
content_sync_settings	array	Required within parent
content_sync_settings[]	Model	Each item	Expand Changes an active team folder's name — response body — content sync settings item
quota_limit	JSON	Optional
quota_limit (anyOf 1)	integer	Alternative
quota_limit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Changes an active team folder's name — response body — content sync settings item, Changes an active team folder's name — response body — sync setting, Changes an active team folder's name — response body — status

Returns the status of an asynchronous job for archiving a team folder — response body — tag failed failed tag access error access error

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	Known values: invalid_team_folder_id, no_access
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: invalid_team_folder_id
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: no_access
$ (anyOf 4)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tag	string	Required within parent	Pattern: ^(?!(?:invalid_team_folder_id|no_access)$)

Returns the status of an asynchronous job for archiving a team folder — response body — tag failed failed tag status error status error

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	Known values: active, archived, archive_in_progress
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: active
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: archived
$ (anyOf 4)	object	Alternative
$ (anyOf 4)..tag	string	Required within parent	Must equal: archive_in_progress
$ (anyOf 5)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 5)..tag	string	Required within parent	Pattern: ^(?!(?:active|archived|archive_in_progress)$)

Returns the status of an asynchronous job for archiving a team folder — response body — tag failed failed tag team shared dropbox error team shared dropbox error

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	Known values: disallowed
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: disallowed
$ (anyOf 3)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 3)..tag	string	Required within parent	Pattern: ^(?!(?:disallowed)$)

Changes an active team folder's name — response body — content sync settings item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Minimum length: 4 Pattern: ^(?:id:.+)$
sync_setting	Model	Required within parent	Expand Changes an active team folder's name — response body — sync setting

Referenced models: Changes an active team folder's name — response body — sync setting

Policy, approvals and errors

SDK function policy ID: dropbox.team_team_folder_archive_check. Catalog operation: team/team_folder_archive_check. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["team_data.content.write"]

Official provider source