Deprecate or delete a version
Deprecation is an optional process that allows you to set a date from which an integration version cannot be used anymore. Zapier is normally a “set it and forget it” experience for users, so use this feature carefully. Only if the version will no longer function, should it be deprecated. Please note that deprecating a version is significantly disruptive to our mutual users if a migration to a different version is not possible.
When users use any but the promoted version, they will see the version displayed and be able to manually update to the promoted version.
What happens after setting a version to deprecate
The deprecation date must be between 3 weeks and 1 year in the future. We won’t communicate the deprecation until 2 weeks before the deprecation date. This gives you time to migrate users to a newer version, before we start notifying them that they need to manually migrate.
1. Email notification
A notification email will be sent exactly 14 days before the configured deprecation date. This email includes the deprecation reason that newer versions of the Zapier CLI ask you for. We do recommend supplementing these automated messages by also notifying your general user base through in-app announcements or email marketing campaigns. For privacy reasons, Zapier cannot provide you with an email list of users of your integration.
2. Deprecation date reached
- Zaps that haven’t been updated will be automatically paused.
- A second email, titled “X Zaps paused over deprecated apps,” will be sent out to those users. Customizing this email is not possible.
- Any attempts to test triggers or actions on the deprecated version will result in an error, and Zaps that use it cannot be enabled.
- The deprecated version will be labelled as “Deprecated” in the Zap editor, with a prompt for users to update to the latest version.
3. Post-deprecation
After the deprecation date, the version will still be visible in the Versions page for your future reference. Users will not be able to see the version once they select a different version in their Zaps.
Deprecate a version with Platform UI
To deprecate an integration version:
- Log into the Platform UI.
- Select your integration.
- In the Manage section in the left sidebar, click Version.
- Click the three dot icon in line with the integration version you want to deprecate.
- Click Deprecate.
- In the dialog box, add the Deprecation Reason and Deprecation Date. You can set a deprecation date anytime between 3 weeks and 1 year from the current date. The deprecation reason will be used in user notifications.
- Click Deprecate.
- Click Close
Deprecate a version with Platform CLI
To deprecate an integration version use the command zapier deprecate
. Learn more about Platform CLI commands.
Deleting deprecated versions
After your version has been deprecated, you have the option to delete versions entirely. Exercise this option with extreme caution. Deleting a version makes it permanently inaccessible, both to you and to your users. Deleted versions cannot be restored by Zapier Developer Support. Deletion should be a last resort, used only when you are certain that the version will never be needed again.
Deletion is also only possible when 0 users remain on a version. The count of users on the Versions page includes live Zaps only. If you’re seeing the error Unable to delete app version
, this can be caused by users on that version not included in the visible count (paused Zaps, app authentications for example).
Need help? Tell us about your problem and we’ll connect you with the right resource or contact support.