DocumentationAPI Reference

Submit your theme

Submit your theme

You can submit your theme to the Zendesk Marketplace as a free theme or paid theme. You can also create a link so customers can preview a demo instance of your theme.

Submitting Marketplace themes

Before submitting your theme, make sure you have registered your organization on the Marketplace developer portal at apps.zendesk.com, and you're signed in to the portal.

To submit an theme

  1. In the Marketplace developer portal, navigate to the themes section and click Submit a new theme (https://apps.zendesk.com/themes/new).

  2. Upload your theme in a ZIP file. It should contain the template files, CSS file, JS file, and the manifest file.

    After you upload the ZIP file, the contents are automatically checked. Any errors found are flagged in red. You won't be able to submit the form until you correct the errors. Warnings are shown in yellow. Warnings are suggestions. You can still submit the theme with them.

    The content of the ZIP file is also checked for compliance with the branding guidelines.

  3. In GitHub link (optional) enter the URL of your public GitHub repo. Providing this information makes it easier and faster for Zendesk to review your submission.

  4. Enter your Marketplace details in the provided fields:

    • Theme name: The unique name of your theme. The name is used to search for the theme. Use a name that's easy to spell and remember. The name can hint at the theme's concept or target audience.

      Note: Don't use Zendesk trademarks or anything that might be construed as related to Zendesk.

    • Short description: A concise summary of your theme, no more than 500 characters long, including spaces. Use sentence case. The short description is displayed when listing themes in the Guide user interface.

      Tip: Use the short description to highlight your theme's benefits, visual identity, or style. If your theme is designed for a specific industry or organization type, mention it in the short description.

    • Long description: A longer, more in-depth description of your theme. Can't exceed 65,000 characters.

      Provide a description of your theme and tell customers a bit about your company. Include the theme's key features, benefits, and unique selling points. Provide links to live examples of how other customers have used the theme. These examples can help new customers understand how they can customize the theme to meet their needs.

      Tip: Use the WYSIWYG editor to format your description. Use imagery and video to increase engagement and draw attention to key points.

  5. In Marketplace hero image, upload your image. The following requirements apply:

    • PNG file format
    • 700 x 520 pixels in size
    • Maximum file size of 500 KB
    • No rounded corners

    Note: Don't use Zendesk trademarks (original or modified), imagery, or design elements that could be interpreted as part of the Marketplace interface or Zendesk brand.

    Tip: The hero image gives users a first impression of your theme. Use the image to show how the theme looks when installed. Don’t crowd the image with extra details, such as feature information.

  6. In Marketplace image library, upload 3 to 25 screenshots of your theme. The screenshots must meet the following requirements:

    • PNG file format
    • Width of at least 320 pixels and no more than 3,840 pixels
    • Length can't be more than twice the width
    • Maximum file size of 500 KB
    • No rounded corners
    • No padding

  7. In Theme demo link (optional), enter the URL of your theme demo instance so customers can preview it. The theme demo should reflect the theme and version that is described on the theme listing page.

    Tip: Although optional, we recommended you provide a theme demo. A demo lets potential customers experience your theme and decide if it’s right for them.

  8. In Terms and conditions link, enter the URL for your theme's terms and conditions agreement.

  9. Select the standard and/or developer license for your theme. For each license type, select the Free or Paid option. For the paid option, select the billing type for your theme and enter the price in USD.

    Before selecting the paid option, make sure you connected your Stripe account to the Zendesk Stripe account. Also make sure you entered your Stripe Integration ID into your organization details.

    For more information about license types, refer to Theme licenses.

  10. Read and agree to the Zendesk Partner and Developer Terms and Privacy Policy.

  11. Click Submit.

Submitting a theme update

An update to an approved or listed theme with a provided demo link should either link to a help center instance using the theme and version that is being submitted for review, or the version already published in the Zendesk Marketplace. For the latter, the demo theme version should be updated to reflect the theme listing version soon after the update is approved.

You can use the multi help center feature to manage a demo link to a corresponding version.

To submit an update

  1. Make changes to the theme, including any updates to its manifest.json file or assets.

  2. Sign in to the Marketplace portal and navigate to the Themes section.

  3. Select Submit Update on the theme tile you wish to update and upload the new ZIP file.

    Make sure to include all necessary files.

  4. Update any information such as payment details and theme demo link.

  5. Read and agree to the Zendesk Partner and Developer Terms.

  6. Click Submit.

What happens next?

After submitting the theme, you'll receive an email confirming that we received it. Please add "[email protected]" to your contact list to ensure you receive e-mail communications from us regarding your submission. You can check on the status of your submission by clicking the Submissions tab in the Themes section of the Marketplace developer portal.

If your theme is approved, you will receive notification of the approval and the listing will be published in the Zendesk Marketplace by 10am PST the next day.

If your theme is rejected, you can submit a new theme by clicking the Submissions tab in the Theme section of the Marketplace developer portal, and clicking on the Submit Update button beneath the original submission.

Note: Do not send in updates or corrections using the Submit a theme button in the upper right corner.

Next steps: Marketing and PR guidelines