Dropbox: Returns the status of an asynchronous job

← Sharing operations · Get started

Operation dropbox.sharing_check_job_status

Provider route: POST /2/sharing/check_job_status. 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["sharing"]["checkJobStatus"]>[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.sharing.checkJobStatus(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.sharing.check_job_status(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 — response body

Referenced models: Returns the status of an asynchronous job — response body

Schemas

8 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 — response body

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	Known values: in_progress, complete
$ (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 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 — response body — tag failed failed

Referenced models: Returns the status of an asynchronous job — response body — tag failed failed

Returns the status of an asynchronous job — response body — tag failed failed

Field	Type	Presence	Description and constraints
$	JSON	Root	Error occurred while performing an asynchronous job from unshare_folder or remove_folder_member.
$ (anyOf 1)	object	Alternative
$ (anyOf 1)..tag	string	Required within parent	Must equal: unshare_folder_error
$ (anyOf 1).unshare_folder_error	Model	Required within parent	Expand Returns the status of an asynchronous job — response body — tag failed failed tag unshare folder error unshare folder error
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: remove_folder_member_error
$ (anyOf 2).remove_folder_member_error	Model	Required within parent	Expand Returns the status of an asynchronous job for sharing a folder — sharing check Remove Member Job Status — response body — tag failed failed
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: relinquish_folder_membership_error
$ (anyOf 3).relinquish_folder_membership_error	Model	Required within parent	Expand Returns the status of an asynchronous job — response body — tag failed failed tag relinquish folder membership error relinquish folder membership error
$ (anyOf 4)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tag	string	Required within parent	Pattern: ^(?!(?:unshare_folder_error|remove_folder_member_error|relinquish_folder_membership_error)$)

Referenced models: Returns the status of an asynchronous job — response body — tag failed failed tag relinquish folder membership error relinquish folder membership error, Returns the status of an asynchronous job for sharing a folder — sharing check Remove Member Job Status — response body — tag failed failed, Returns the status of an asynchronous job — response body — tag failed failed tag unshare folder error unshare folder error

Returns the status of an asynchronous job — response body — tag failed failed tag relinquish folder membership error relinquish folder membership error

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	Known values: folder_owner, mounted, group_access, team_folder, no_permission, no_explicit_access
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: access_error
$ (anyOf 2).access_error	Model	Required within parent	Expand Returns the status of an asynchronous job for sharing a folder — sharing check Remove Member Job Status — response body — tag failed failed tag access error access error
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: folder_owner
$ (anyOf 4)	object	Alternative
$ (anyOf 4)..tag	string	Required within parent	Must equal: mounted
$ (anyOf 5)	object	Alternative
$ (anyOf 5)..tag	string	Required within parent	Must equal: group_access
$ (anyOf 6)	object	Alternative
$ (anyOf 6)..tag	string	Required within parent	Must equal: team_folder
$ (anyOf 7)	object	Alternative
$ (anyOf 7)..tag	string	Required within parent	Must equal: no_permission
$ (anyOf 8)	object	Alternative
$ (anyOf 8)..tag	string	Required within parent	Must equal: no_explicit_access
$ (anyOf 9)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 9)..tag	string	Required within parent	Pattern: ^(?!(?:access_error|folder_owner|mounted|group_access|team_folder|no_permission|no_explicit_access)$)

Referenced models: Returns the status of an asynchronous job for sharing a folder — sharing check Remove Member Job Status — response body — tag failed failed tag access error access error

Returns the status of an asynchronous job for sharing a folder — sharing check Remove Member Job Status — response body — tag failed failed

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	Known values: folder_owner, group_access, team_folder, no_permission, too_many_files
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: access_error
$ (anyOf 2).access_error	Model	Required within parent	Expand Returns the status of an asynchronous job for sharing a folder — sharing check Remove Member Job Status — response body — tag failed failed tag access error access error
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: member_error
$ (anyOf 3).member_error	Model	Required within parent	Expand Returns the status of an asynchronous job for sharing a folder — sharing check Remove Member Job Status — response body — tag failed failed tag member error member error
$ (anyOf 4)	object	Alternative
$ (anyOf 4)..tag	string	Required within parent	Must equal: folder_owner
$ (anyOf 5)	object	Alternative
$ (anyOf 5)..tag	string	Required within parent	Must equal: group_access
$ (anyOf 6)	object	Alternative
$ (anyOf 6)..tag	string	Required within parent	Must equal: team_folder
$ (anyOf 7)	object	Alternative
$ (anyOf 7)..tag	string	Required within parent	Must equal: no_permission
$ (anyOf 8)	object	Alternative
$ (anyOf 8)..tag	string	Required within parent	Must equal: too_many_files
$ (anyOf 9)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 9)..tag	string	Required within parent	Pattern: ^(?!(?:access_error|member_error|folder_owner|group_access|team_folder|no_permission|too_many_files)$)

Referenced models: Returns the status of an asynchronous job for sharing a folder — sharing check Remove Member Job Status — response body — tag failed failed tag access error access error, Returns the status of an asynchronous job for sharing a folder — sharing check Remove Member Job Status — response body — tag failed failed tag member error member error

Removes a specified member from the file — response body — tag success access details array item

Field	Type	Presence	Description and constraints
$	object	Root	Contains information about a parent folder that a member has access to.
folder_name	string	Required within parent
shared_folder_id	string	Required within parent	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
permissions	array	Required within parent
permissions[]	Model	Each item	Expand Returns shared folder membership by its folder ID — response body — users item permissions array item
path	string	Required within parent

Referenced models: Returns shared folder membership by its folder ID — response body — users item permissions array item

Policy, approvals and errors

SDK function policy ID: dropbox.sharing_check_job_status. Catalog operation: sharing/check_job_status. 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: ["sharing.write"]

Official provider source