Box Developer Documentation
Log in
Beta

Update hub collaboration

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

Updates a hub collaboration. Can be used to change the 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 hub. Possible values are editor, viewer, and co-owner.

Response

application/jsonHub Collaboration

Returns an updated 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 hub collaboration
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

TypeScript Gen
await client.hubCollaborations.updateHubCollaborationByIdV2025R0(
  createdCollaboration.id,
  { role: 'editor' } satisfies HubCollaborationUpdateRequestV2025R0,
);
Python Gen
client.hub_collaborations.update_hub_collaboration_by_id_v2025_r0(
    created_collaboration.id, role="editor"
)
.NET Gen
await client.HubCollaborations.UpdateHubCollaborationByIdV2025R0Async(hubCollaborationId: createdCollaboration.Id, requestBody: new HubCollaborationUpdateRequestV2025R0() { Role = "editor" });
Swift Gen (Beta)
try await client.hubCollaborations.updateHubCollaborationByIdV2025R0(hubCollaborationId: createdCollaboration.id, requestBody: HubCollaborationUpdateRequestV2025R0(role: "editor"))
Java Gen (Beta)
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"
}