Dropbox: Once an async job id is returned from members add , use this to poll the status of the asynchronous request
Dropbox team.membersAddJobStatusGet: arguments, response, policy and SDK examples.
← Team operations · Get started
Operation dropbox.team_members_add_job_status_get
Provider route: POST /2/team/members/add/job_status/get. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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"]["membersAddJobStatusGet"]>[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.membersAddJobStatusGet(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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.members_add_job_status_get(arguments) result = await call.wait() return result.body_json()| 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
Section titled “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 Once an async job id is returned from members add , use this to poll the status of the asynchronous request — response body |
Referenced models: Once an async job id is returned from members add , use this to poll the status of the asynchronous request — response body
Schemas
Section titled “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)$) |
Once an async job id is returned from members add , use this to poll the status of the asynchronous request — 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).complete | array | Required within parent | |
$ (anyOf 3).complete[] | Model | Each item | Expand Once an async job id is returned from members add , use this to poll the status of the asynchronous request — response body — tag complete complete item |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: failed |
$ (anyOf 4).failed | string | Required within parent |
Referenced models: Once an async job id is returned from members add , use this to poll the status of the asynchronous request — response body — tag complete complete item
Once an async job id is returned from members add , use this to poll the status of the asynchronous request — response body — tag complete complete item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Describes the result of attempting to add a single user to the team. 'success' is the only value indicating that a user was indeed added to the team - the other values explain the type of failure that occurred, and include the email of the user for which the operation has failed. |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: team_license_limit |
$ (anyOf 1).team_license_limit | string | Required within parent | Maximum length: 255 Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$ |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: free_team_member_limit_reached |
$ (anyOf 2).free_team_member_limit_reached | string | Required within parent | Maximum length: 255 Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$ |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: user_already_on_team |
$ (anyOf 3).user_already_on_team | string | Required within parent | Maximum length: 255 Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$ |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: user_on_another_team |
$ (anyOf 4).user_on_another_team | string | Required within parent | Maximum length: 255 Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$ |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: user_already_paired |
$ (anyOf 5).user_already_paired | string | Required within parent | Maximum length: 255 Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$ |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: user_migration_failed |
$ (anyOf 6).user_migration_failed | string | Required within parent | Maximum length: 255 Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$ |
$ (anyOf 7) | object | Alternative | |
$ (anyOf 7)..tag | string | Required within parent | Must equal: duplicate_external_member_id |
$ (anyOf 7).duplicate_external_member_id | string | Required within parent | Maximum length: 255 Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$ |
$ (anyOf 8) | object | Alternative | |
$ (anyOf 8)..tag | string | Required within parent | Must equal: duplicate_member_persistent_id |
$ (anyOf 8).duplicate_member_persistent_id | string | Required within parent | Maximum length: 255 Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$ |
$ (anyOf 9) | object | Alternative | |
$ (anyOf 9)..tag | string | Required within parent | Must equal: persistent_id_disabled |
$ (anyOf 9).persistent_id_disabled | string | Required within parent | Maximum length: 255 Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$ |
$ (anyOf 10) | object | Alternative | |
$ (anyOf 10)..tag | string | Required within parent | Must equal: user_creation_failed |
$ (anyOf 10).user_creation_failed | string | Required within parent | Maximum length: 255 Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$ |
$ (anyOf 11) | object | Alternative | |
$ (anyOf 11)..tag | string | Required within parent | Must equal: success |
$ (anyOf 11).profile | Model | Required within parent | Expand Updates a team member's profile — team members Set Profile — response body — profile |
$ (anyOf 11).role | Model | Required within parent | Expand Updates a team member's profile — team members Set Profile — response body — role |
Referenced models: Updates a team member's profile — team members Set Profile — response body — role, Updates a team member's profile — team members Set Profile — response body — profile
Updates a team member's profile — team members Set Profile — response body — role
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Describes which team-related admin permissions a user has. |
$ (anyOf 1) | string | Alternative | Known values: team_admin, user_management_admin, support_admin, member_only |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: team_admin |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: user_management_admin |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: support_admin |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: member_only |
Updates a team member's profile — team members Set Profile — response body — profile secondary emails array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Required within parent | Maximum length: 255 Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$ |
is_verified | boolean | Required within parent |
Updates a team member's profile — team members Set Profile — response body — profile status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | The user's status as a member of a specific team. |
$ (anyOf 1) | string | Alternative | Known values: active, invited, suspended |
$ (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: invited |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: suspended |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: removed |
$ (anyOf 5).is_recoverable | boolean | Required within parent | |
$ (anyOf 5).is_disconnected | boolean | Required within parent |
Updates a team member's profile — team members Set Profile — response body — profile membership type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: full, limited |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: full |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: limited |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: dropbox.team_members_add_job_status_get. Catalog operation: team/members_add_job_status_get. 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: ["members.write"]