Dropbox: Returns the status of an asynchronous job for sharing a folder — sharing check Share Job Status

← Sharing operations · Get started

Operation dropbox.sharing_check_share_job_status

Provider route: POST /2/sharing/check_share_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"]["checkShareJobStatus"]>[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.checkShareJobStatus(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_share_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 for sharing a folder — sharing check Share Job Status — response body

Referenced models: Returns the status of an asynchronous job for sharing a folder — sharing check Share Job Status — response body

Schemas

20 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 sharing a folder — sharing check Share Job Status — 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 Share a folder with collaborators — 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 sharing a folder — sharing check Share Job Status — response body — tag failed failed

Referenced models: Returns the status of an asynchronous job for sharing a folder — sharing check Share Job Status — response body — tag failed failed, Share a folder with collaborators — response body — tag complete

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

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	Known values: email_unverified, team_policy_disallows_member_policy, disallowed_shared_link_policy, no_permission
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: email_unverified
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: bad_path
$ (anyOf 3).bad_path	Model	Required within parent	Expand Returns the status of an asynchronous job for sharing a folder — sharing check Share Job Status — response body — tag failed failed tag bad path bad path
$ (anyOf 4)	object	Alternative
$ (anyOf 4)..tag	string	Required within parent	Must equal: team_policy_disallows_member_policy
$ (anyOf 5)	object	Alternative
$ (anyOf 5)..tag	string	Required within parent	Must equal: disallowed_shared_link_policy
$ (anyOf 6)	object	Alternative
$ (anyOf 6)..tag	string	Required within parent	Must equal: too_many_mounts
$ (anyOf 6).too_many_mounts	Model	Required within parent	Expand Returns the status of an asynchronous job for sharing a folder — sharing check Share Job Status — response body — tag failed failed tag too many mounts too many mounts
$ (anyOf 7)	object	Alternative
$ (anyOf 7)..tag	string	Required within parent	Must equal: no_permission
$ (anyOf 8)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 8)..tag	string	Required within parent	Pattern: ^(?!(?:email_unverified|bad_path|team_policy_disallows_member_policy|disallowed_shared_link_policy|too_many_mounts|no_permission)$)

Referenced models: Returns the status of an asynchronous job for sharing a folder — sharing check Share Job Status — response body — tag failed failed tag bad path bad path, Returns the status of an asynchronous job for sharing a folder — sharing check Share Job Status — response body — tag failed failed tag too many mounts too many mounts

Share a folder with collaborators — response body — tag complete

Field	Type	Presence	Description and constraints
$	object	Root
.tag	string	Required within parent	Must equal: complete
access_type	Model	Required within parent	Expand The current user mounts the designated folder — response body — access type
is_inside_team_folder	boolean	Required within parent
is_team_folder	boolean	Required within parent
owner_display_names	JSON	Optional
owner_display_names (anyOf 1)	array	Alternative
owner_display_names (anyOf 1)[]	string	Each item
owner_display_names (anyOf 2)	null	Alternative
owner_team	JSON	Optional
owner_team (anyOf 1)	Model	Alternative	Expand Update the viewer info policy of a file — response body — owner team Information about a team
owner_team (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
path_display	JSON	Optional
path_display (anyOf 1)	string	Alternative
path_display (anyOf 2)	null	Alternative
path_lower	JSON	Optional
path_lower (anyOf 1)	string	Alternative
path_lower (anyOf 2)	null	Alternative
parent_folder_name	JSON	Optional
parent_folder_name (anyOf 1)	string	Alternative
parent_folder_name (anyOf 2)	null	Alternative
link_metadata	JSON	Optional
link_metadata (anyOf 1)	Model	Alternative	Expand Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder
link_metadata (anyOf 2)	null	Alternative
name	string	Required within parent
permissions	JSON	Optional
permissions (anyOf 1)	array	Alternative
permissions (anyOf 1)[]	Model	Each item	Expand The current user mounts the designated folder — response body — permissions array item
permissions (anyOf 2)	null	Alternative
policy	Model	Required within parent	Expand Update the viewer info policy of a file — response body — policy
preview_url	string	Required within parent
shared_folder_id	string	Required within parent	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
time_invited	string	Required within parent
access_inheritance	Model	Optional	Expand The current user mounts the designated folder — response body — access inheritance
folder_id	JSON	Optional
folder_id (anyOf 1)	string	Alternative	Minimum length: 4 Pattern: ^(?:id:.+)$
folder_id (anyOf 2)	null	Alternative

Referenced models: The current user mounts the designated folder — response body — access inheritance, The current user mounts the designated folder — response body — access type, The current user mounts the designated folder — response body — permissions array item, Update the viewer info policy of a file — response body — policy, Update the viewer info policy of a file — response body — link metadata Metadata of a shared link for a file or folder, Update the viewer info policy of a file — response body — owner team Information about a team

The current user mounts the designated folder — response body — access inheritance

Field	Type	Presence	Description and constraints
$	JSON	Root	Information about the inheritance policy of a shared folder.
$ (anyOf 1)	string	Alternative	Known values: inherit, no_inherit
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: inherit
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: no_inherit
$ (anyOf 4)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tag	string	Required within parent	Pattern: ^(?!(?:inherit|no_inherit)$)

Policy, approvals and errors

SDK function policy ID: dropbox.sharing_check_share_job_status. Catalog operation: sharing/check_share_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