Create permission with the OneDrive API

Shares a file or folder with people by email, with read or write access, and returns the new permissions. With sendInvitation true, OneDrive emails them a link. The top folder of a personal drive cannot be shared.

Identifier
onedrive_create_permission

The request

POST https://connect.reportei.com/api/tools/onedrive_create_permission/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>",
    "recipients": [],
    "roles": []
  }
}

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.
recipientsarrayYesPeople who get access.
rolesarrayYesread or write.
sendInvitationbooleanNotrue emails the people a sharing link; false only grants the access.
requireSignInbooleanNotrue makes the people sign in to open the item.
messagestringNoPlain text added to the invitation email.
expirationDateTimestringNoWhen the access ends, in UTC. Not every account type supports it.

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