box_collaboration_folder_user_by_user_id_tool
Invite a user to collaborate on a Box folder by specifying their user ID, assign roles, set access permissions, and configure notification and expiration settings.
Instructions
Create a collaboration on a folder with a user specified by user ID. Args: client (BoxClient): Authenticated Box client. folder_id (str): The ID of the folder to collaborate on. user_id (str): The ID of the user to collaborate with. role (str): The role to assign to the collaborator. Default is "editor". Available roles are editor, viewer, previewer, uploader, viewer_uploader, co-owner. is_access_only (Optional[bool]): If set to true, collaborators have access to shared items, but such items won't be visible in the All Files list. Additionally, collaborators won't see the path to the root folder for the shared item. expires_at (Optional[DateTime]): The expiration date of the collaboration. notify (Optional[bool]): Whether to notify the collaborator via email. Returns: Dict[str, Any]: Dictionary containing collaboration details or error message.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| folder_id | Yes | ||
| user_id | Yes | ||
| role | No | editor | |
| is_access_only | No | ||
| can_view_path | No | ||
| expires_at | No | ||
| notify | No |