| Announced on | Rollout starts | Rollout ends |
| April 2, 2024 | July 2, 2024 | July 2, 2024 |
We're announcing an upcoming update to the URL structure returned in responses from the Article Attachments API.
What’s changing, and why?
Currently, the Article Attachments API response includes the attachment file name in both the URL (after content_url) and separately in a file_name attribute. To increase the persistence and reliability of our attachment URLs, we are modifying the response structure to remove the file name from the content_url while still providing it in the file_name attribute.
This change aims to ensure that your attachment links remain valid even if the file names change, enhancing the stability and functionality of our platform for all users.
The older URLs provided by the API before this update will still function as usual.
How will this affect me?
For most users, there will be no noticeable impact. The API will continue to function as it currently does but with an updated URL format that does not include the file name.
If you developed custom integrations that parse the file name from the URL, you will need to adjust your integration to use the file_name attribute provided in the API response because parsing the URL will no longer yield the file name.
What do I need to do?
No action is required if you are not using custom integrations that parse the file name from the content_url. However, if you are, please update your integration logic to reference the file_name attribute for the file name data.
Zendesk cannot determine which accounts might have such custom code so we are unable to provide personalized notifications. We encourage customers who have built custom integrations to review their code and prepare for this change.
For more information, about the Article attachment API see developer documentation.
If you have questions or need assistance, contact Zendesk Customer Support. If you have product feedback or feature requests related to this announcement, visit our community forum where we collect and manage customer product feedback.