Video Management API

Content-Type: application/json

Example:

{
  "total_records": 1,
  "next_page_token": "yqT59YnBSHqvDdNnkeHQsA",
  "channels": [
    {
      "channel_id": "iso9Dllddp39dagjLj9j",
      "name": "FoodieFlicks",
      "description": "A cinematic journey through the world of cuisine!.",
      "owner_id": "abc9Dllddp39dagjLj9j",
      "status": "PUBLISH",
      "categories": [
        "Education"
      ]
    }
  ]
}

• name (required)

  string — The name of the channel.

• categories

  array — The category of the channel. Use categories to classify your videos and help viewers filter videos.

  Items:

  string

• description

  string — A description of the channel.

• thumbnails

  array — Thumbnail metadata updates. Each entry references an uploaded file by `file_id`.

  Items:

  • file_id (required)

    string — The unique file reference ID from the file upload API.

Content-Type: application/json

Example:

{
  "channel_id": "iso9Dllddp39dagjLj9j",
  "name": "FoodieFlicks",
  "description": "A cinematic journey through th world of cuisine!",
  "status": "PUBLISHED",
  "categories": [
    "Education"
  ]
}

Content-Type: application/json

Example:

{
  "channel_id": "iso9Dllddp39dagjLj9j",
  "name": "FoodieFlicks",
  "description": "A cinematic journey through the world of cuisine!.",
  "owner_id": "abc9Dllddp39dagjLj9j",
  "status": "PUBLISH",
  "categories": [
    "Education"
  ],
  "channel_link": "https://videocenter.zoom.us/e/channels/MYysLCuzQ0mmk1CvarkaDA",
  "access_type": "PEOPLE_WITH_ACCESS",
  "thumbnails": [
    {
      "file_url": "https://files.zoom.us/thumbnails/thumb123.jpg"
    }
  ]
}

• access_type

  string, possible values: "PEOPLE_WITH_ACCESS", "ANYONE_IN_ORG", "ANYONE_WITH_LINK" — The channel access type: * `PEOPLE_WITH_ACCESS` = Only people with access * `ANYONE_IN_ORG` = Anyone in the same organization can access using the channel link * `ANYONE_WITH_LINK` = Anyone can access using the channel link

• categories

  array — The category of the channel. Categories allow you to classify your videos and help viewers filter videos.

  Items:

  string

• description

  string — Channel description.

• name

  string — The name of the channel.

• thumbnails

  array — The thumbnail metadata updates. Each entry references an uploaded file by `file_id`.

  Items:

  • file_id (required)

    string — The unique file reference ID from the file upload API.

• operation

  string, possible values: "publish", "unpublish" — The available actions for a video channel. * `publish` — Publish the channel. * `unpublish` — Un-publish the published channel.

Content-Type: application/json

Example:

{
  "total_records": 10,
  "next_page_token": "yqT59YnBSHqvDdNnkeHQsA",
  "permissions": [
    {
      "user_id": "IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2",
      "chat_channel_id": "dc1731cf94a842bfb43e8b0fe13d2a46@conference.xmppdev.zoom.us",
      "display_name": "John Doe",
      "role": "VIEWER",
      "invite_status": "PENDING"
    }
  ]
}

• permissions

  array — The list of channel permissions to be added.

  Items:

  All of:

  • role (required)

    string, possible values: "COLLABORATOR", "VIEWER" — The channel user's role: * `COLLABORATOR` = A channel user with collaborator permissions * `VIEWER` = A channel user with view permissions

  One of:

  • user_id (required)

    string — The Zoom user ID.

  • chat_channel_id (required)

    string — The chat channel ID.

• permissions

  array — The permissions to delete.

  Items:

  One of:

  • user_id (required)

    string — The Zoom user ID.

  • chat_channel_id (required)

    string — The chat channel ID.

• permissions

  array — The list of channel permissions to be updated.

  Items:

  All of:

  • role (required)

    string, possible values: "COLLABORATOR", "VIEWER" — The channel user's role: * `COLLABORATOR` = A channel user with collaborator permissions * `VIEWER` = A channel user with view permissions

  One of:

  • user_id (required)

    string — The Zoom user ID.

  • chat_channel_id (required)

    string — The chat channel ID.

Content-Type: application/json

Example:

{
  "total_records": 1,
  "next_page_token": "yqT59YnBSHqvDdNnkeHQsA",
  "playlists": [
    {
      "playlist_id": "csduzfv3JwTeyR5QpC3PXw52",
      "name": "My Playlist1"
    }
  ]
}

• playlist_ids (required)

  array — The playlist IDs.

  Items:

  string

• playlist_ids (required)

  array — The playlist IDs.

  Items:

  string

Content-Type: application/json

Example:

{
  "total_records": 1,
  "next_page_token": "yqT59YnBSHqvDdNnkeHQsA",
  "playlists": [
    {
      "playlist_id": "csduzfv3JwTeyR5QpC3PXw52",
      "name": "My Playlist1",
      "thumbnails": [
        {
          "file_url": "https://files.example.com/thumbnails/thumb123.jpg"
        }
      ]
    }
  ]
}

• name (required)

  string — The name of the playlist.

• thumbnails

  array — Thumbnail metadata updates. Each entry references an uploaded file by `file_id`.

  Items:

  • file_id (required)

    string — The unique file reference ID from the file upload API.

Content-Type: application/json

Example:

{
  "playlist_id": "iso9Dllddp39dagjLj9j",
  "name": "FoodieFlicks"
}

• name

  string — The name of the playlist.

• thumbnails

  array — The thumbnail metadata updates. Each entry references an uploaded file by `file_id`.

  Items:

  • file_id (required)

    string — The unique file reference ID from the file upload API.

Content-Type: application/json

Example:

{
  "total_records": 1,
  "next_page_token": "yqT59YnBSHqvDdNnkeHQsA",
  "videos": [
    {
      "video_id": "csduzfv3JwTeyR5QpC3PXw52",
      "video_name": "My Recording1",
      "play_link": "https://abc/recording/unehd6TtTLuTN40owCOqqK",
      "duration": 3000,
      "video_status": "COMPLETED",
      "video_source": "RECORDING"
    }
  ]
}

• videos (required)

  array — The list of videos to add to the channel.

  Items:

  One of:

  • video_id (required)

    string — The video ID.

  • meeting_id (required)

    string — Zoom meeting ID. Add recording from a specific meeting.

• videos (required)

  array — The list of videos to remove from the channel.

  Items:

  One of:

  • video_id (required)

    string — The video ID.

  • meeting_id (required)

    string — Zoom meeting ID. Remove the recording of a specific meeting.

Content-Type: application/json

Example:

{
  "total_records": 1,
  "next_page_token": "yqT59YnBSHqvDdNnkeHQsA",
  "videos": [
    {
      "video_id": "csduzfv3JwTeyR5QpC3PXw52",
      "video_name": "My Recording1",
      "play_link": "https://abc/recording/unehd6TtTLuTN40owCOqqK",
      "duration": 3000,
      "video_status": "COMPLETED",
      "video_source": "RECORDING"
    }
  ]
}

• videos (required)

  array — The list of videos to add to the playlist.

  Items:

  One of:

  • video_id (required)

    string — The video ID.

  • meeting_id (required)

    string — Zoom meeting ID. Use this to add the recording from a specific meeting.

• videos (required)

  array — The list of videos to remove from the playlist.

  Items:

  One of:

  • video_id (required)

    string — The video ID.

  • meeting_id (required)

    string — Zoom meeting ID. Remove the recording from a specific meeting.

Content-Type: application/json

Example:

{
  "total_records": 1,
  "next_page_token": "yqT59YnBSHqvDdNnkeHQsA",
  "videos": [
    {
      "video_id": "csduzfv3JwTeyR5QpC3PXw52",
      "video_name": "My Recording1",
      "description": "Updated description text.",
      "external_id": "legacy_vid_789",
      "notes": "This video contains onboarding information.",
      "play_link": "https://abc/recording/unehd6TtTLuTN40owCOqqK",
      "duration": 3000,
      "video_status": "COMPLETED",
      "video_source": "RECORDING",
      "owner_name": "John Doe",
      "owner_email": "john.doe@xyz.com",
      "created_time": "2022-06-03T20:51:00Z",
      "modified_time": "2022-06-03T20:51:00Z"
    }
  ]
}

Content-Type: application/json

Example:

{
  "video_name": "My Recording1",
  "description": "Updated description text.",
  "external_id": "legacy_vid_789",
  "notes": "This video contains onboarding information.",
  "play_link": "https://abc/recording/unehd6TtTLuTN40owCOqqK",
  "duration": 3000,
  "video_status": "COMPLETED",
  "video_source": "RECORDING",
  "thumbnails": [
    {
      "file_url": "https://files.zoom.us/thumbnails/thumb123.jpg"
    }
  ],
  "owner_name": "John Doe",
  "owner_email": "john.doe@xyz.com",
  "created_time": "2022-06-03T20:51:00Z",
  "modified_time": "2022-06-03T20:51:00Z"
}

• description

  string — Detailed description or summary of the video content.

• external_id

  string — Used to link the migrated media ID from an external system.

• notes

  string — Additional information or notes about the video.

• thumbnails

  array — Thumbnail metadata updates. Each entry references an uploaded file by `file_id`.

  Items:

  • file_id (required)

    string — The unique file reference ID from the file upload API.

• transcripts

  array — Transcript updates. Each item references an uploaded transcript file and can include a language code. The `language` field is currently supported only for videos with the source `RECORDING`. For all other video source types, `language` is ignored, and the provided transcript file overwrites the existing transcript, if present.

  Items:

  • file_id (required)

    string — The unique file reference ID from the file upload API.

  • is_default

    boolean — Whether this transcript file is the default caption file. The default transcript is displayed first by the player. When the first transcript file is uploaded, it automatically becomes the default regardless of whether this field is explicitly set.

  • language

    string — The language code (ISO 639-1 or BCP 47).

• video_name

  string — The name of the video.

• file (required)

  string — The upload file, in binary format. You can only send a maximum of 2 GB.

Content-Type: application/json

Example:

{
  "file_id": "xBvggqyjQUal6TecwMlYwE"
}