Dropbox: Returns the status of an asynchronous job for create folder batch

← Files operations · Get started

Operation dropbox.files_create_folder_batch_check

Provider route: POST /2/files/create_folder_batch/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["files"]["createFolderBatchCheck"]>[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.files.createFolderBatchCheck(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.files.create_folder_batch_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 create folder batch — response body

Referenced models: Returns the status of an asynchronous job for create folder batch — response body

Schemas

4 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 create folder batch — 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)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: complete
$ (anyOf 3).entries	array	Required within parent
$ (anyOf 3).entries[]	Model	Each item	Expand Create multiple folders at once — response body — tag complete entries item
$ (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 create folder batch — response body — tag failed failed
$ (anyOf 5)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 5)..tag	string	Required within parent	Pattern: ^(?!(?:in_progress|complete|failed)$)

Referenced models: Returns the status of an asynchronous job for create folder batch — response body — tag failed failed, Create multiple folders at once — response body — tag complete entries item

Returns the status of an asynchronous job for create folder batch — response body — tag failed failed

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

Create multiple folders at once — response body — tag complete entries item

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative
$ (anyOf 1)..tag	string	Required within parent	Must equal: success
$ (anyOf 1).metadata	Model	Required within parent	Expand Create a folder at a given path — response body — metadata
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: failure
$ (anyOf 2).failure	Model	Required within parent	Expand Create multiple folders at once — response body — tag complete entries item tag failure failure

Referenced models: Create a folder at a given path — response body — metadata, Create multiple folders at once — response body — tag complete entries item tag failure failure

Create a folder at a given path — response body — metadata

Field	Type	Presence	Description and constraints
$	object	Root
name	string	Required within parent
path_lower	JSON	Optional
path_lower (anyOf 1)	string	Alternative
path_lower (anyOf 2)	null	Alternative
path_display	JSON	Optional
path_display (anyOf 1)	string	Alternative
path_display (anyOf 2)	null	Alternative
parent_shared_folder_id	JSON	Optional
parent_shared_folder_id (anyOf 1)	string	Alternative	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
parent_shared_folder_id (anyOf 2)	null	Alternative
preview_url	JSON	Optional
preview_url (anyOf 1)	string	Alternative
preview_url (anyOf 2)	null	Alternative
id	string	Required within parent	Minimum length: 1
shared_folder_id	JSON	Optional
shared_folder_id (anyOf 1)	string	Alternative	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
shared_folder_id (anyOf 2)	null	Alternative
sharing_info	JSON	Optional
sharing_info (anyOf 1)	Model	Alternative	Expand Create a folder at a given path — response body — metadata sharing info no access, parent shared folder id, read only, shared folder id, traverse only
sharing_info (anyOf 2)	null	Alternative
property_groups	JSON	Optional
property_groups (anyOf 1)	array	Alternative
property_groups (anyOf 1)[]	Model	Each item	Expand Add property groups to a Dropbox file — request body — body property groups item
property_groups (anyOf 2)	null	Alternative

Referenced models: Add property groups to a Dropbox file — request body — body property groups item, Create a folder at a given path — response body — metadata sharing info no access, parent shared folder id, read only, shared folder id, traverse only

Create multiple folders at once — response body — tag complete entries item tag failure failure

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative
$ (anyOf 1)..tag	string	Required within parent	Must equal: path
$ (anyOf 1).path	Model	Required within parent	Expand Check the status of a save url job — response body — tag failed failed tag path path
$ (anyOf 2)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 2)..tag	string	Required within parent	Pattern: ^(?!(?:path)$)

Referenced models: Check the status of a save url job — response body — tag failed failed tag path path

Add property groups to a Dropbox file — request body — body property groups item

Field	Type	Presence	Description and constraints
$	object	Root	A subset of the property fields described by the corresponding PropertyGroupTemplate. Properties are always added to a Dropbox file as a PropertyGroup. The possible key names and value types in this group are defined by the corresponding PropertyGroupTemplate.
template_id	string	Required within parent	Minimum length: 1 Pattern: ^(?:(/|ptid:).*)$
fields	array	Required within parent
fields[]	Model	Each item	Expand Add property groups to a Dropbox file — request body — body property groups item fields item

Referenced models: Add property groups to a Dropbox file — request body — body property groups item fields item

Create a folder at a given path — response body — metadata sharing info no access, parent shared folder id, read only, shared folder id, traverse only

Field	Type	Presence	Description and constraints
$	object	Root	Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.
read_only	boolean	Required within parent
parent_shared_folder_id	JSON	Optional
parent_shared_folder_id (anyOf 1)	string	Alternative	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
parent_shared_folder_id (anyOf 2)	null	Alternative
shared_folder_id	JSON	Optional
shared_folder_id (anyOf 1)	string	Alternative	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
shared_folder_id (anyOf 2)	null	Alternative
traverse_only	boolean	Optional
no_access	boolean	Optional

Policy, approvals and errors

SDK function policy ID: dropbox.files_create_folder_batch_check. Catalog operation: files/create_folder_batch_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: ["files.content.write"]

Official provider source