Box Developer Documentation
Log in
Beta

Copy hub

post
https://api.box.com/2.0
/hubs/:hub_id/copy

Creates a copy of a Hub.

The original Hub will not be modified.

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

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

Description of the Hub.

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 new Hub object.

application/jsonClient error

Returns an error when the user does not have the right permissions to create a Hub.

application/jsonClient error

An unexpected client error.

post
Copy hub
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

TypeScript Gen
await client.hubs.copyHubV2025R0(createdHub.id, {
  title: copiedHubTitle,
  description: copiedHubDescription,
} satisfies HubCopyRequestV2025R0);
Python Gen
client.hubs.copy_hub_v2025_r0(
    created_hub.id, title=copied_hub_title, description=copied_hub_description
)
.NET Gen
await client.Hubs.CopyHubV2025R0Async(hubId: createdHub.Id, requestBody: new HubCopyRequestV2025R0() { Title = copiedHubTitle, Description = copiedHubDescription });
Swift Gen (Beta)
try await client.hubs.copyHubV2025R0(hubId: createdHub.id, requestBody: HubCopyRequestV2025R0(title: copiedHubTitle, description: copiedHubDescription))
Java Gen (Beta)
client.getHubs().copyHubV2025R0(createdHub.getId(), new HubCopyRequestV2025R0.Builder().title(copiedHubTitle).description(copiedHubDescription).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
}