Box Developer Documentation
Log in
Beta

Update hub information by ID

put
https://api.box.com/2.0
/hubs/:hub_id

Updates a Hub. Can be used to change title, description, or Hub settings.

Request

bearer [ACCESS_TOKEN]
application/json

Request Headers

stringin headerrequired

Version header.

Value is always 2025.0

Path Parameters

stringin pathrequired
12345

The unique identifier that represent a hub.

The ID for any hub can be determined by visiting this hub in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/hubs/123 the hub_id is 123.

Request Body

booleanin bodyoptional
true

Indicates if non-owners can invite others to the Hub.

booleanin bodyoptional
true

Indicates if a shared link can be created for the Hub.

stringin bodyoptional
"This is a description of the Hub."

Description of the Hub.

booleanin bodyoptional
true

Indicates if AI features are enabled for the Hub.

booleanin bodyoptional
true

Indicates if collaboration is restricted to the enterprise.

stringin bodyoptional
"Hub Title"
50

Title of the Hub. It cannot be empty and should be less than 50 characters.

Response

application/jsonHub

Returns a Hub object.

application/jsonClient error

Returned when the access token provided in the Authorization header is not recognized or not provided.

application/jsonClient error

Returned if the Hub is not found, or the user does not have access to the Hub.

application/jsonClient error

An unexpected client error.

put
Update hub information by ID
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

TypeScript Gen
await client.hubs.updateHubByIdV2025R0(hubId, {
  title: newHubTitle,
  description: newHubDescription,
} satisfies HubUpdateRequestV2025R0);
Python Gen
client.hubs.update_hub_by_id_v2025_r0(
    hub_id, title=new_hub_title, description=new_hub_description
)
.NET Gen
await client.Hubs.UpdateHubByIdV2025R0Async(hubId: hubId, requestBody: new HubUpdateRequestV2025R0() { Title = newHubTitle, Description = newHubDescription });
Swift Gen (Beta)
try await client.hubs.updateHubByIdV2025R0(hubId: hubId, requestBody: HubUpdateRequestV2025R0(title: newHubTitle, description: newHubDescription))
Java Gen (Beta)
client.getHubs().updateHubByIdV2025R0(hubId, new HubUpdateRequestV2025R0.Builder().title(newHubTitle).description(newHubDescription).build())

Response Example

{
  "id": "12345",
  "type": "hubs",
  "can_non_owners_invite": true,
  "can_shared_link_be_created": true,
  "created_at": "2012-12-12T10:53:43Z",
  "created_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "description": "All the contracts for the company.",
  "is_ai_enabled": true,
  "is_collaboration_restricted_to_enterprise": true,
  "title": "Contracts",
  "updated_at": "2012-12-12T10:53:43Z",
  "updated_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "view_count": 506
}