Manifests (early preview)

Manifests are JSON-formatted files that contain the configuration for Zoom Apps. With a manifest, you can use the Marketplace build-flow or an API to create a general app with a pre-defined configuration or adjust the configuration of existing general apps. Manifests are also portable, so you can share and reuse them.

Scope for early preview:

Manifests (early preview) supports:

  • The ability to download a manifest JSON file for an app from the build-flow.
  • The ability to update the configuration for an existing app from a manifest.

Out of scope for early preview:

  • The ability to create an app from a manifest.

Known issues/limitations for early preview:

  • The manifest feature only updates the app's user-editable values. We use the build-flow UX to verify completeness.

Prerequisites

  • Zoom has accepted you into the manifest early preview program.
  • You have a Zoom account.
  • You are either the Zoom account owner, or account admin or have been assigned the Zoom for developers role.
  • You have experience creating apps in the Zoom Marketplace.
  • The app is a general app.

Download a manifest for an existing app

  1. Log into the Zoom Marketplace, go to Manage, and select a general app for which you want to download a manifest.
  2. Select a method of opening the manifest: in the persistent menu bar, or on the Basic Information page.
  3. Select the download icon to download the manifest file to your local system.
  4. You can now open the manifest JSON file on your local system and update the app's fields and attributes. For information about fields in the manifest, see Manifest Structure.

Upload a manifest for an existing app

You can modify an app's configurations in its manifest file and then upload the changes to the Marketplace. For information about updating fields in the manifest, see Manifest Structure.

  1. Log into the Zoom Marketplace, go to Manage, and select a general app for which you want to download a manifest.

  2. Select a method of opening the manifest: in the persistent menu bar, or on the Basic Information page.

  3. Select Upload New Manifest.

  4. The build-flow checks the manifest for errors and displays a green checkmark when it is complete.

  5. Close the manifest window, refresh your browser, and confirm the changes are properly applied to your app.

Common mistakes

  • JSON schema error. Values are entered incorrectly or missing.
  • Unsupported custom values.
  • Values are case-sensitive.
  • The manifest file is not in valid JSON format.
  • Entered values do not meet requirements. Check manifest format according to docs.
  • You don't have permission to the app.

Validation error examples

  • The display name can't be empty.
  • The display name length should be less than 50 characters.
  • The app name contains invalid characters.
  • The description length should be less than 150 characters.
  • The long description length should be less than 2000 characters.

Resources