Create sharing link with the OneDrive API

Creates a sharing link for a file or folder, or returns the link of the same type that already exists, as a permission whose link.webUrl is the link to send.

Identifier
onedrive_create_sharing_link

The request

POST https://connect.reportei.com/api/tools/onedrive_create_sharing_link/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>",
    "type": "view"
  }
}

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.
typestringYesview is read only, edit allows changes, embed is for a web page and works only on files of personal accounts.Values: view, edit, embed
scopestringNoanonymous lets in anyone with the link, if the organization allows it; organization, anyone signed in to the same work or school organization; users, only people given access. Without it, the default of the organization applies.Values: anonymous, organization, users
expirationDateTimestringNoWhen the link stops working, in UTC, as 2026-12-31T23:59:59Z.
passwordstringNoPassword of the link. Personal accounts only.

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_create_sharing_link. 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.