User Guide

What this tool does

Updates the apiVersion field in your Salesforce metadata. It does not modify any code, logic, or configuration, only the API version number.

Keeping metadata on a current API version ensures access to the latest platform features and avoids deprecated API behavior.

Supported metadata types

  • Apex Classes (.cls)
  • Apex Triggers (.trigger)
  • Visualforce Pages (.page)
  • Visualforce Components (.component)
  • Aura Components (Aura bundles)
  • Lightning Web Components (LWC bundles)
  • Flows (deploying creates a new version, the tool optionally cleans up obsolete versions)

Only unmanaged components are shown. Managed package components are excluded.

Step 0: Install the package (once per org)

SF API Version Updater uses a free managed package to register the OAuth connection. Salesforce is retiring legacy Connected Apps in favor of External Client Apps, which must be installed in each org before they can authorize users. Only needs to be done once per org.

  1. Click the install button for your org type below.
  2. You'll land on Salesforce's package install screen. Log in if prompted.
  3. Choose "Install for All Users" (or admins only).
  4. Click Install. May take a minute or two.
  5. Once done, come back and log in.

If you see an "app not installed" error when logging in, the tool will automatically redirect you here.

How to use

  1. Install the package: see Step 0 above. One-time per org.
  2. Log in: click Login (Production) or Login (Sandbox) to authorize via OAuth.
  3. Select metadata types: choose which types to review and click "Load Components."
  4. Review components: each row shows the current API version and a status: Current Outdated Deprecated
  5. Select components: use checkboxes, "Select all," or the search and filter controls.
  6. Choose target version: defaults to the latest available API version.
  7. Set test level: optionally run Apex tests during deployment. Failed tests trigger auto-rollback.
  8. Backup: "Download backup first" is checked by default. Saves a ZIP of original metadata.
  9. Update: click "Update Selected Components" and watch progress in the log panel.

Syncing changes to your repo

After a successful deploy, the tool generates everything you need to pull the updated metadata into your local SFDX project. No need to manually re-retrieve the whole org or overwriting source files.

  1. 1. Download the manifest: click "Download package.xml" to get a manifest scoped to exactly the components that were updated. Place it at manifest/sf-api-updated-package.xml in your repo root.
  2. 2. Retrieve: run the SF CLI command to pull only those components into your local project.
    sf project retrieve start --manifest manifest/sf-api-updated-package.xml
  3. 3. Stage metadata files: run the git add command (bash/zsh or PowerShell) to stage only the -meta.xml files. Companion source files (.cls, .trigger, etc.) are left unstaged for you to handle manually.
  4. 4. Commit: review the staged changes and commit.

Flow version management

Deploying an updated Flow creates a new version. The old version becomes inactive.

Enable "Delete previous (inactive) Flow version after successful update" to clean up automatically. Leave it off if you want to keep the old version as a rollback point.

Security & privacy

  • Credentials are never stored on any server.
  • Tokens live in browser session storage only (cleared when the tab closes).
  • The Cloudflare Worker proxy is stateless: it forwards requests without storing data.
  • Metadata is processed entirely in your browser memory.
  • All traffic uses HTTPS.
  • The source code is fully open source.

Prerequisites

  • A Salesforce org (Production, Developer, or Sandbox)
  • A user with API Access and Modify All Data or Author Apex
  • For Flows: Manage Flows permission
  • A modern browser (Chrome, Firefox, Edge, Safari)