Salesforce DX Developer Guide
jNewer Version Available
Push a Package Upgrade for Unlocked Packages
Push upgrades enable you to upgrade packages installed in subscriber orgs, without
asking customers to install the upgrade themselves. You can choose which orgs receive a push
upgrade, what version the package is upgraded to, and when you want the upgrade to occur. Push
upgrades are particularly helpful If you need to push a change for a hot bug fix.
Use SOAP API to initiate the push upgrade, track the status of each job, and review error messages if any push upgrades fail. Here are the objects that help with push upgrades.
| To Do This: | Use This Object: |
|---|---|
| Retrieve details about your package version. | MetadataPackageVersion SOAP API |
| Retrieve information about the subscriber org, such as the org ID and the package version currently installed. | PackageSubscriber SOAP API |
| Schedule a push upgrade, or check the status of the push upgrade. | PackagePushRequest SOAP API |
| Specify the org to receive the push upgrade. Create an individual package push job for every org receiving the push upgrade. | PackagePushJob SOAP API |
| Review any error messages associated with a push upgrade request. | PackagePushError SOAP API |
Push Upgrade Considerations for Unlocked Packages
- You can include new and changed features, or remove features during a push upgrade.
- When a push upgrade is installed, the Apex in the package is complied.
- You can use push upgrades even if the package version requires a password.