Copy item with the OneDrive API

Copies a file or folder, with its contents, to a folder or under a new name. The copy runs in the background: the response is 202 with no body, and the new item shows up in List items once it is done. Sharing is not copied.

Identifier
onedrive_copy_item

The request

POST https://connect.reportei.com/api/tools/onedrive_copy_item/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "item_id": "<item_id>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
item_idstringYesFile or folder id from List items, Search items or Get item.
parentReferenceobjectNoDestination folder. Omit it to copy into the same folder, with a new name.
namestringNoName of the copy. Without it the copy keeps the original name.

Supported connections

Your customer connects their OneDrive account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/onedrive, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/onedrive_copy_item. It becomes your agent's tool definition with no conversion.

Other OneDrive tools

See all 11 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.