Salesforce Platform API Versions 7.0 through 20.0 Retirement

What action did I need to take?

Before the Summer '21 release, customers and partners should have modified or upgraded their applications to function with the most current API versions available to prevent any disruption caused by software referencing retired versions. Moving to newer versions of our APIs will offer advanced capabilities with improved security and performance. Before the Summer '22 release, customers and partners had to modify or upgrade their applications to function with the most current API versions.

If your Outbound Messaging listener is set up to make a return SOAP call to Salesforce using the EnterpriseURL or PartnerURL sent in the payload, you would need to either configure your client to modify the API URL to use a version greater than 20.0 or you will need to recreate the message in the Salesforce Setup (which will set the API version to the latest available on the current release).  When creating a new Outbound Messaging definition, you can attach it to an existing workflow rule and remove the previous OBMM from that workflow.

How did I know if impacted versions of the Legacy APIs were used in my applications?

To identify applications using APIs that will be retired, contact the developers of applications you use in your org to determine what API versions are being used.

If you cannot contact the developers of your applications, you can review event logs that report SOAP and REST API activity from your Salesforce orgs by following these steps: 

1. Use a tool such as the Salesforce CLI to run a SOQL query against the EventLogFile* object, which will provide you with a log of all actions taken within your org during the last 24 hours.
   • sfdx force:data:soql:query -q "SELECT LogFile, EventType, CreatedDate FROM EventLogFile WHERE EventType IN ('API', 'RestApi', 'ApiTotalUsage')" -u <your-username>
2. For each result, perform a REST request using the endpoint to obtain the data and copy into a .CSV file.
   • e.g. /services/data/v52.0/sobjects/EventLogFile/0AT3i000005vXpWGAU/LogFile
   • Paste the response body into an application such as Excel to more easily view the event log data as a .CSV file.
3. Review each .CSV file and determine if requests are being made to endpoints with API versions 20 and below.
   • SOAP / API EventType -- review values in column API_VERSION for records of API_TYPE of “E” or “P”
   • REST / RestApi EventType -- review values in column URI and note endpoints featuring “/v20.0” or lower in the path
   • API Total Usage / ApiTotalUsage EventType -- review all events with API_VERSION of 20 and below
4. Any integrations that consume versions 20 and below will be impacted by this API retirement.

*Access to “API” and “RestAPI” EventLogFile types requires an add-on license to Event Monitoring.  You will need to contact your Salesforce sales representative or Account Executive to purchase the Event Monitoring add-on.

Take the Event Monitoring Trailhead Module for more information and explore how to easily view events with the Salesforce Event Log File Browser.

For the Bulk API, navigate to the “Bulk Data Load Jobs” page within Setup and view the details of each “Bulk V1” job. Any job that features a value of 20.0 or below within the “API Version” field was impacted by this API retirement.

For SOAP login() operations, navigate to the “Login History” page within Setup and review the entries with “SOAP Enterprise” or “SOAP Partner” as the API Type. Alternatively, the LoginHistory sObject can be queried via SOQL. Any login entry that features a value of 20.0 or below within the “API Version” field was be impacted by this API retirement.

Partners can leverage the Package Usage Logs for insights on their legacy API consumption.

*Summer ’21 - Free “ApiTotalUsage” Event Type

The “API Total Usage” event type was made available in the Summer ’21 release. This event type consolidates relevant request information across the SOAP, Login, Bulk, and REST APIs, including version information. See the event definition details here.

To view these events, follow steps 1 thru 4 above or use the Salesforce Event Log File Browser.

API-enabled organizations have free access to the API Total Usage event log files with 1-day data retention. For an extra cost, you can access this and all other log file types with 30-day data retention.

Why did retire this product?

Salesforce is focusing our development efforts on enhancing the latest API versions to improve the overall Salesforce experience when building custom functionality via applications.

How can I get more information?

For more information about what features the latest API version supports, visit the Salesforce Developer site and refer to the following documentation:

• Introducing SOAP API Developer Guide
• Introducing Lightning Platform REST API
  • “REST” covers all APIs with endpoint URIs under /services/data/vXX.Y/ where XX.Y is the API version. This includes the “standard” Lightning Platform REST API to work with sObjects and records and records but also the following resources:
    • Tooling API
    • Chatter/Connect API
    • Query API
    • Search API
    • Login API (aka “Identity”)

• For the Summer '22 milestone, observe the results of a REST request to GET /services/data/v20.0 to understand the set of top-level resources that will be affected when v20.0 endpoints are retired.
• Introduction to Bulk API
• Understanding Outbound Messaging

If you have more questions, open a case with Support via Salesforce Help. To view all current and past feature retirements, see Salesforce Product & Feature Retirement.

To read about the Salesforce approach to retiring, read our Product & Feature Retirement Philosophy.