Create collaboration

POST https://{{api.box.com}}/2.0/collaborations

Adds a collaboration for a single user or a single group to a file

https://developer.box.com/reference/post-collaborations

Request Params

Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. | | notify | boolean | | Determines if users should receive email notification for the action performed. |

Request Body

{"item"=>{"type"=>"file", "id"=>"11446498"}, "accessible_by"=>{"type"=>"user", "id"=>"23522323", "login"=>"john@example.com"}, "role"=>"editor", "is_access_only"=>true, "can_view_path"=>true, "expires_at"=>"2019-08-29T23:59:00-07:00"}

HEADERS

RESPONSES

status: Created

{"id":"12345678","type":"collaboration","item":{"id":"12345","etag":"1","type":"file","sequence_id":"3","name":"Contract.pdf","sha1":"85136C79CBF9FE36BB9D05D0639C70C265C18D37","file_version":{"id":"12345","type":"file_version","sha1":"134b65991ed521fcfe4724b7d814ab8ded5185dc"},"description":"Contract for Q1 renewal","size":629644,"path_collection":{"total_count":1,"entries":[{"id":"12345","etag":"1","type":"folder","sequence_id":"3","name":"Contracts"}]},"created_at":"2012-12-12T10:53:43-08:00","modified_at":"2012-12-12T10:53:43-08:00","trashed_at":"2012-12-12T10:53:43-08:00","purged_at":"2012-12-12T10:53:43-08:00","content_created_at":"2012-12-12T10:53:43-08:00","content_modified_at":"2012-12-12T10:53:43-08:00","created_by":{"id":"11446498","type":"user","name":"Aaron Levie","login":"ceo@example.com"},"modified_by":{"id":"11446498","type":"user","name":"Aaron Levie","login":"ceo@example.com"},"owned_by":{"id":"11446498","type":"user","name":"Aaron Levie","login":"ceo@example.com"},"shared_link":{"url":"https://www.box.com/s/vspke7y05sb214wjokpk","download_url":"https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg","vanity_url":"https://acme.app.box.com/v/my_url/","vanity_name":"my_url","access":"open","effective_access":"company","effective_permission":"can_download","unshared_at":"2018-04-13T13:53:23-07:00","is_password_enabled":true,"permissions":{"can_download":true,"can_preview":true,"can_edit":false},"download_count":3,"preview_count":3},"parent":{"id":"12345","etag":"1","type":"folder","sequence_id":"3","name":"Contracts"},"item_status":"active"},"accessible_by":{"id":"11446498","type":"user","name":"Aaron Levie","login":"ceo@example.com"},"invite_email":"john@example.com","role":"editor","expires_at":"2012-12-26T10:53:43-08:00","is_access_only":true,"status":"accepted","acknowledged_at":"2012-12-12T10:55:20-08:00","created_by":[{"id":33224412},{"type":"user"},{"login":"dylan@example.com"},{"name":"Dylan Smith"}],"created_at":"2012-12-12T10:53:43-08:00","modified_at":"2012-12-12T10:53:43-08:00","acceptance_requirements_status":{"terms_of_service_requirement":{"is_accepted":true,"terms_of_service":{"id":"11446498","type":"terms_of_service"}},"strong_password_requirement":{"enterprise_has_strong_password_required_for_external_users":true,"user_has_strong_password":true},"two_factor_authentication_requirement":{"enterprise_has_two_factor_auth_enabled":true,"user_has_two_factor_authentication_enabled":true}}}