Announced on | Rollout starts | Rollout ends |
August 19, 2024 | August 20, 2024 | August 20, 2024 |
Zendesk is excited to announce the Public API for Media, a solution designed to streamline the interaction and management of images and article attachments through external integrations based on REST API.
This announcement includes the following topics:
What is changing?
We are launching the Public API for Media, which provides comprehensive CRUD (create, read, update, delete) capabilities as well as advanced features like media renaming and replacement, categorization, and permission controls. This new API marks the beginning of a phased transition towards replacing the current HC API with a more refined and sophisticated API landscape.
With the Public API for Media, developers can programmatically manage media resources through a centralized Guide Media Library, a repository designed to handle all media files at the account level.
Core functionalities include:
- Create Media: Upload new images and article attachments to the media library with relevant metadata.
- Read Media: Retrieve and view media files and their details.
- Update Media:
- Renaming Media: Update the names of images and article attachments.
- Replacing Media: Replace existing media in all their placements.
- Delete Media: Remove outdated or unnecessary media to keep the repository clean.
Why is Zendesk making this change?
The Public API for media management is essential for maintaining consistency and branding across various projects. It simplifies media management by offering a centralized repository for monitoring and overseeing all media files. This update will boost efficiency in updating and maintaining media content and foster improved collaboration by providing shared access to media resources. Ultimately, this transition to the new API will empower developers with superior external integration capabilities, paving the way for a more refined and sophisticated API landscape, gradually phasing out the current HC API.
What do I need to do?
Customers using the current HC API for media management will need to transition to the new Public API for Media to take advantage of its enhanced functionalities and capabilities. Developers should review Guide Medias in the developer documentation to understand how to interact with the new API and make necessary adjustments to their integrations.
If you have feedback or questions related to this announcement, visit our community forum where we collect and manage customer product feedback. For general assistance with your Zendesk products, contact Zendesk Customer Support.