Hub API

Content-Type: application/json

Example:

{
  "file_name": "Q3 Plan",
  "file_content": "name,age\nAlice,30\nBob,25"
}

Content-Type: application/json

Example:

{
  "task_id": "copy-5nXkADVAQkqbfX-hNZv00x-a1b2c3",
  "status": "succeeded",
  "duplicated_file_id": "9fQkADVAQkqbfX-hNZv00x",
  "error": {
    "reason": "REASON_PERMISSION_DENIED",
    "message": "You do not have permission to duplicate this file."
  }
}

• file_name

  string — The name for the duplicated file. If omitted, the source file name or the product-specific duplicate naming rule is used.

• parent_id

  string — The ID of the destination folder, including a folder in My Files or a shared folder. If omitted or set to `root`, the file is duplicated to the effective user's My Files folder. The destination must exist and allow the effective user to create the duplicated file.

Content-Type: application/json

Example:

{
  "task_id": "copy-5nXkADVAQkqbfX-hNZv00x-a1b2c3"
}

• file_type (required)

  string, possible values: "doc", "paper_doc", "spreadsheet" — The type of file to create.

• content

  string — The plain-text content in the format expected for the selected `file_type`. If omitted or empty, an empty file is created.

• file_name

  string — The name of the file.

• parent_id

  string — The ID of the parent file. The newly created file will become a child of this parent. If this parameter is omitted, the file will be placed under **My Files**. Use `root` to represent the top-level folder of the current user. Folders can only be created under **My Files**, a shared folder, or another folder.

Content-Type: application/json

Example:

{
  "file_id": "ch4L4KKgQVesEJcqdt1qIw",
  "file_link": "https://docs.zoom.us/doc/ch4L4KKgQVesEJcqdt1qIw"
}

Content-Type: application/json

Example:

{
  "shared_folders": [
    {
      "shared_folder_id": "61kkJE-rR52UsywN25E0hQ",
      "shared_folder_name": "Weekly Reports",
      "shared_folder_link": "https://docs.zoom.us/space/61kkJE-rZCx8qCcR1Wed37SAqlCZg",
      "created_time": "2025-06-30T09:47:40.249Z",
      "modified_time": "2025-06-30T09:47:40.249Z",
      "pinned": true,
      "joined": true
    }
  ],
  "next_page_token": "eyJ0aW1lQ3Vyc29yIjoiMjAyNS0wNC0yMVQwOTo0NTo1OC45NTJaIiwiaWRDdXJzb3IiOiJzemFsMkpmTlFteTExY1JwdkYxRWhBIn0="
}

• shared_folder_name (required)

  string — The shared folder name.

Content-Type: application/json

Example:

{
  "shared_folder_id": "g-VlWaWgQP-z-qJr3dAbEA",
  "description": "This shared folder is used to collect weekly reports",
  "visibility": "open",
  "external_user_access_enabled": true,
  "member_default_file_role": "viewer",
  "shared_folder_name": "Weekly Reports"
}

Content-Type: application/json

Example:

{
  "shared_folder_name": "Weekly Reports",
  "description": "This shared folder is used to collect weekly reports",
  "visibility": "open",
  "external_user_access_enabled": true,
  "member_default_file_role": "viewer",
  "shared_folder_id": "g-VlWaWgQP-z-qJr3dAbEA"
}

• description

  string — The description of the shared folder.

• external_user_access_enabled

  boolean — Once set to `false`, external users cannot be added to or access any files in this shared folder. Existing external members will also lose access.

• member_default_file_role

  string, possible values: "viewer", "commenter", "editor" — The default file role inherited by members of the shared folder.

• shared_folder_name

  string — The shared folder name.

• visibility

  string, possible values: "open", "private" — Controls the shared folder's visibility, discoverability, and self-service join behavior.

Content-Type: application/json

Example:

{
  "shared_folder_name": "Weekly Reports",
  "description": "This shared folder is used to collect weekly reports",
  "visibility": "open",
  "external_user_access_enabled": true,
  "member_default_file_role": "viewer",
  "shared_folder_id": "g-VlWaWgQP-z-qJr3dAbEA"
}