| to | No | share_out: the recipient's email | |
| node | No | request, declassify, hold, share_out, set_settings: the document or folder, by id instead of location. A console link (`/d/<Name-Slug>-<32 hex>`, whole or just its id) is accepted too. | |
| note | No | approve, decline: a note to the requester | |
| role | No | share: viewer opens it; editor also edits; manager can also approve access requests for it, share it and grant within it. Sharing needs manager on this folder or one above it, or editor there to share as viewer or editor, unless its owner turned editor sharing off (access_grant action=set_settings). reader, writer and approver are deprecated aliases for viewer, editor and manager · request, share_out: default viewer. editor can also edit; manager (request only) can also share it, grant within it and decide requests for it. An approved request gives the role to everyone you work under who lacks it, too. Asking for a role you already hold, or one below it (manager implies editor, editor implies viewer), is refused. reader, writer and approver are deprecated aliases for viewer, editor and manager | |
| wait | No | request: also register a wait for the decision | |
| action | Yes | what to do; each action takes the arguments its line names | |
| emails | No | share: email addresses to share with (at most 20 per call) | |
| reason | No | request, hold, share_out: why you are doing this, in one line (at most 200 characters); recorded with the event and exported with the log | |
| source | No | declassify: the label's source, a path or node id. A console link (`/d/<Name-Slug>-<32 hex>`, whole or just its id) is accepted too. | |
| approve | No | decide_share: true to offer it, false to decline | |
| sources | No | declassify: which read sources to release (paths or node ids); default all. A console link (`/d/<Name-Slug>-<32 hex>`, whole or just its id) is accepted too. | |
| deadline | No | request: with wait: when to stop waiting (ISO) | |
| identity | No | hold: an identity id, to hold its drafts | |
| location | No | share: full path from the workspace root, e.g. "handbook/vendor/acme.md" (as printed by browse action=documents or search) · request, declassify, hold, share_out, accept_share, set_settings: the document or folder, by path; accept_share: the folder to put it in, only you can see (default the top level) | |
| share_id | No | accept_share, decline_share, decide_share: the share's id, from access_read action=offers, shared or proposals | |
| request_id | No | approve, decline: the request's id, from access_read action=requests or my_requests | |
| scope_type | No | share: default folder | |
| continuation | No | request: with wait: a note to your future self for when it resolves | |
| organization | No | accept_share: the organization to put an accepted share in, by id or name: only the one this connection is in; omit for that one | |
| confirm_token | No | share: from the first call. Calling without it PREVIEWS: nothing is shared. | |
| idempotency_key | No | Any unique string you choose for this write, e.g. a UUID. If you retry the call with the same key and the same arguments, the first answer is returned and nothing is done twice. Reusing a key for a different request is refused. Keys are kept 24 hours. | |
| editors_can_share | No | set_settings: true lets editors share here, false stops them, null clears this node's own setting so it inherits | |