Box Developer Documentation
Log in
Latest version

Update Box Hub collaboration

put
https://api.box.com/2.0
/hub_collaborations/:hub_collaboration_id

Updates a Box Hub collaboration. Can be used to change the Box Hub role.

Request

bearer [ACCESS_TOKEN]
application/json

Request Headers

stringin headerrequired

Version header.

Value is always 2025.0

Path Parameters

stringin pathrequired
1234

The ID of the hub collaboration.

Request Body

stringin bodyoptional
"editor"

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

Response

application/jsonBox Hub Collaboration

Returns an updated Box Hub collaboration object.

application/jsonClient error

Returns an error if the authenticated user does not have the right permissions to update the collaboration.

application/jsonClient error

An unexpected client error.

put
Update Box Hub collaboration
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

Learn more about Box SDK versioning strategy.


Node/TypeScript v10
await client.hubCollaborations.updateHubCollaborationByIdV2025R0(
  createdCollaboration.id,
  { role: 'editor' } satisfies HubCollaborationUpdateRequestV2025R0,
);
Python v10
client.hub_collaborations.update_hub_collaboration_by_id_v2025_r0(
    created_collaboration.id, role="editor"
)
.NET v10
await client.HubCollaborations.UpdateHubCollaborationByIdV2025R0Async(hubCollaborationId: createdCollaboration.Id, requestBody: new HubCollaborationUpdateRequestV2025R0() { Role = "editor" });
Swift v10
try await client.hubCollaborations.updateHubCollaborationByIdV2025R0(hubCollaborationId: createdCollaboration.id, requestBody: HubCollaborationUpdateRequestV2025R0(role: "editor"))
Java v10
client.getHubCollaborations().updateHubCollaborationByIdV2025R0(createdCollaboration.getId(), new HubCollaborationUpdateRequestV2025R0.Builder().role("editor").build())

Response Example

{
  "id": "12345678",
  "type": "hub_collaboration",
  "acceptance_requirements_status": {
    "strong_password_requirement": {
      "enterprise_has_strong_password_required_for_external_users": true,
      "user_has_strong_password": true
    },
    "terms_of_service_requirement": {
      "is_accepted": true,
      "terms_of_service": {
        "id": "11446498",
        "type": "terms_of_service"
      }
    },
    "two_factor_authentication_requirement": {
      "enterprise_has_two_factor_auth_enabled": true,
      "user_has_two_factor_authentication_enabled": true
    }
  },
  "accessible_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "hub": {
    "id": "12345",
    "type": "hubs"
  },
  "role": "editor",
  "status": "accepted"
}