Skip to main content
POST
/
hub_collaborations
cURL
curl --request POST \
  --url https://api.box.com/2.0/hub_collaborations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'box-version: <box-version>' \
  --data '
{
  "hub": {
    "type": "hubs",
    "id": "42037322"
  },
  "accessible_by": {
    "type": "user",
    "id": "23522323",
    "login": "[email protected]"
  },
  "role": "editor"
}
'
{
  "id": "12345678",
  "type": "hub_collaboration",
  "hub": {
    "id": "12345",
    "type": "hubs"
  },
  "accessible_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "[email protected]"
  },
  "role": "editor",
  "status": "accepted",
  "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
    }
  }
}
Learn more about Box SDK versioning strategy.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
box-version
enum<string>
required

Version header.

Available options:
2025.0

Body

application/json

Request body for creating a new Box Hub collaboration.

​
hub
Box Hubs reference · object
required

Box Hubs reference.

​
accessible_by
object
required

The user or group who gets access to the item.

​
role
string
required

The level of access granted to a Box Hub. Possible values are editor, viewer, and co-owner.

Example:

"editor"

Response

Returns a new Box Hub collaboration object.

A Box Hub collaboration object grants a user or group access to a Box Hub with permissions defined by a specific role.

​
id
string
required

The unique identifier for this collaboration.

Example:

"12345678"

​
type
enum<string>
required

The value will always be hub_collaboration.

Available options:
hub_collaboration
Example:

"hub_collaboration"

​
hub
Box Hub (Base) · object

The bare basic representation of a Box Hub.

​
accessible_by
Box Hub Collaboration User · object

A mini representation of a user, can be returned only when the status is pending.

​
role
string

The level of access granted to a Box Hub. Possible values are editor, viewer, and co-owner.

Example:

"editor"

​
status
enum<string>

The status of the collaboration invitation. If the status is pending, login and name return an empty string.

Available options:
accepted,
pending,
rejected
Example:

"accepted"

​
acceptance_requirements_status
object