Beta

Share it

Last updated Nov 19, 2026View as MarkdownAgent setup / MCP
POST
/v1/access

Shares a Room, folder, File, task or goal with someone, or changes their level. A folder or File shared with someone outside gives them just that. A Room is shared by email (it sends an invitation). Needs Full access (a task or goal: also whoever made it). Requires explicit user intent.

Authorization

headerAuthorizationBearer <token>

A signed-in SMB user's access token. Workspace-scoped operations also require SMB-Workspace-Id.

Header Parameters

SMB-Workspace-Id*string

Workspace where this operation runs. Required for user tokens and Workspace API keys.

Formatuuid
Idempotency-Key*string
Length8 <= length <= 200

Request Body

application/json
  1. body
object_type*ObjectType

What to share: a Room, a folder, a Room file, a File, a task or a goal.

Value in"room""room_folder""room_file""file""task""goal"
object_id*string

Its ID: rom_, rfd_, rfl_, fil_, tsk_ or gol_.

Length1 <= length <= 40
to*|||

Who: a person by email or account, a Workspace you are in, or (tasks and goals) everyone in their Room.

access_level*string
Value in"view""edit""full_access"

Response Body

The existing resource or idempotent replay was returned.

application/json
  1. response
subject*
access_level*string
Value in"view""edit""full_access"
source_type*SourceType

Where it comes from: given here (api, participant, invite), inherited from a folder above, or room (everyone who can open the Room).

inherited_from?
created_at*string
request_id*string
curl -X POST 'https://example.com/v1/access' \  -H 'SMB-Workspace-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Idempotency-Key: stringst' \  -H 'Content-Type: application/json' \  -d '{  "object_type": "room",  "object_id": "string",  "to": {    "type": "person",    "email": "user@example.com"  },  "access_level": "view"}'
{  "subject": {    "type": "string",    "id": "string",    "label": "string",    "email": "string"  },  "access_level": "view",  "source_type": "string",  "inherited_from": {    "type": "room_folder",    "id": "string",    "name": "string"  },  "created_at": "string",  "request_id": "string"}