Box Create Collaboration

The level of access granted. Valid values are: 'editor' (full read/write access), 'viewer' (read-only access), 'previewer' (preview-only), 'uploader' (upload-only), 'previewer uploader' (preview and upload), 'viewer uploader' (view and upload), or 'co-owner' (full access includi…

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response u…

Determines if users should receive email notification for the action performed.

The unique ID of the file or folder to grant access to. Required for creating a new collaboration. You can find this ID in the Box web interface URL or from other API responses.

Set the expiration date for the collaboration. At this date, the collaboration will be automatically removed from the item. This feature will only work if the **Automatically remove invited collaborators: Allow folder owners to extend the expiry date** setting has been enabled i…

The type of the item that this collaboration will be granted access to. Must be either 'file' or 'folder'. Required for creating a new collaboration.

Determines if the invited users can see the entire parent path to the associated folder. The user will not gain privileges in any parent folder and therefore can not see content the user is not collaborated on. Be aware that this meaningfully increases the time required to load…

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 the path to the root folder for the shared item.

The Box user ID or group ID to invite. Either this field or 'accessible_by_login' must be provided (not both). Use this when you know the exact Box user/group ID.

The type of collaborator to invite. Must be either 'user' or 'group'. Required. Use 'user' when inviting an individual (by email or user ID), or 'group' when sharing with a Box group.

The email address of the user to invite as a collaborator. Either this field or 'accessible_by_id' must be provided (not both). Use this for user invitations when you have the email address but not the Box user ID. Not applicable for groups.