Dropbox: Updates an existing Paper doc with the provided content
Dropbox files.paperUpdate: arguments, response, policy and SDK examples.
← Files operations · Get started
Operation dropbox.files_paper_update
Provider route: POST /2/files/paper/update. 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["files"]["paperUpdate"]>[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.paperUpdate(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.files.paper_update(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
headers | object | Required within parent | Additional keys: not allowed |
headers.Dropbox-API-Arg | Model | Required within parent | Expand Updates an existing Paper doc with the provided content — request body — headers Dropbox-API-Arg |
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 | object | Required within parent | Additional keys: not allowed |
body.filename | string | Required within parent | Minimum length: 1 |
body.content_type | string | Required within parent | Minimum length: 1 |
body.content_base64 | string | Required within parent |
Referenced models: Deletes a group — request body — headers Dropbox-API-Path-Root, Updates an existing Paper doc with the provided content — request body — headers Dropbox-API-Arg
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 Updates an existing Paper doc with the provided content — response body |
Referenced models: Updates an existing Paper doc with the provided content — response body
Schemas
Section titled “Schemas”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)$) |
Updates an existing Paper doc with the provided content — request body — headers Dropbox-API-Arg
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
path | string | Required within parent | Pattern: ^(?:(/(.|[\r\n])*)|(ns:[0-9]+(/(.|[\r\n])*)?)|(id:.*))$ |
import_format | Model | Required within parent | Expand Creates a new Paper doc with the provided content — request body — headers Dropbox-API-Arg import format |
doc_update_policy | Model | Required within parent | Expand Updates an existing Paper doc with the provided content — request body — headers Dropbox-API-Arg doc update policy |
paper_revision | JSON | Optional | |
paper_revision (anyOf 1) | integer | Alternative | |
paper_revision (anyOf 2) | null | Alternative |
Referenced models: Creates a new Paper doc with the provided content — request body — headers Dropbox-API-Arg import format, Updates an existing Paper doc with the provided content — request body — headers Dropbox-API-Arg doc update policy
Updates an existing Paper doc with the provided content — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
paper_revision | JSON | Required within parent | |
paper_revision (anyOf 1) | integer | Alternative | |
paper_revision (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Creates a new Paper doc with the provided content — request body — headers Dropbox-API-Arg import format
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | The import format of the incoming Paper doc content. |
$ (anyOf 1) | string | Alternative | One of: html, markdown, plain_text |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: html |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: markdown |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: plain_text |
$ (anyOf 5) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 5)..tag | string | Required within parent | Pattern: ^(?!(?:html|markdown|plain_text)$) |
Updates an existing Paper doc with the provided content — request body — headers Dropbox-API-Arg doc update policy
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | One of: update, overwrite, prepend, append |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: update |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: overwrite |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: prepend |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: append |
$ (anyOf 6) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 6)..tag | string | Required within parent | Pattern: ^(?!(?:update|overwrite|prepend|append)$) |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: dropbox.files_paper_update. Catalog operation: files/paper_update. 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"]