Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.box.com/llms.txt

Use this file to discover all available pages before exploring further.

To share content with a user, create a collaboration using the user ID or email address, the ID of the content, and the role or permissions level the user should have when accessing the content. The collaboration roles are editor,viewer, previewer, uploader, previewer uploader, viewer uploader,co-owner, or owner. For a full description of each role, please refer to our support documentation. 
curl -i -X POST "https://api.box.com/2.0/collaborations" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "item": {
         "type": "file",
         "id": "11446498"
       },
       "accessible_by": {
         "type": "user",
         "login": "user@example.com"
       },
       "role": "editor"
     }'

​
Nested objects

When creating a collaboration there are two nested objects within the request body: accessible_by and item. The accessible_by object specifies who the item should be shared with and includes a group id and the type. The type field should always be set to user. The item object specifies what is being shared. It includes a type field which should be set as file and an id for that file.