What To Know
- Can I change the API name of a flow that is used in a process builder.
- What happens if I change the API name of a flow that is used in a custom component.
- If you change the API name of a flow that is used in a custom component, you need to update the custom component to use the new API name.
Changing the API name of a flow in Salesforce is a crucial step when customizing and managing your workflow automations. The API name is a unique identifier used in code and integrations to reference the flow. Modifying it allows you to rename the flow, improve clarity, and align it with your business processes. This guide will provide a comprehensive walkthrough on how to change flow API name Salesforce, ensuring a seamless and efficient process.
Prerequisites
Before proceeding, ensure you have the following:
- Access to a Salesforce developer or administrator account
- Knowledge of Salesforce Flow Builder
- Understanding of API names and their significance
Step-by-Step Guide
1. Navigate to Flow Manager
Log in to your Salesforce account and navigate to the Flow Manager page. You can access it by clicking the “Setup” gear icon and searching for “Flow Manager.”
2. Select the Flow
From the Flow Manager page, locate and select the flow whose API name you want to change. Click on the flow name to open its details page.
3. Edit Flow Properties
On the flow details page, click on the “Edit Properties” button located on the top-right corner. This will open a modal window where you can modify various properties of the flow, including its API name.
4. Change API Name
In the “Edit Properties” modal, locate the “API Name” field. Enter the new API name you want to use for the flow. Ensure it is unique and follows the Salesforce API naming conventions.
5. Save Changes
Once you have entered the new API name, click on the “Save” button to apply the changes. Salesforce will update the flow with the new API name.
6. Verify API Name Change
After saving the changes, return to the Flow Manager page and refresh it. You should see the updated API name displayed for the flow.
7. Update Integrations and Code
If you have any integrations or code that references the flow using its old API name, update them to use the new API name. This will ensure that your integrations and code continue to function correctly.
Considerations
- API Name Limitations: Salesforce API names must be unique within the organization and cannot exceed 255 characters.
- Impact on Running Flows: Changing the API name of a running flow may not immediately affect its execution. However, it is recommended to pause or stop running flows before making any changes to their properties.
- Versioning: If the flow is versioned, changing the API name will apply to the current and future versions of the flow.
Final Thoughts
Changing the flow API name Salesforce is a straightforward process that allows you to customize and manage your workflow automations effectively. By following the steps outlined in this guide, you can easily modify the API name of your flows, ensuring clarity, alignment, and seamless integration with your business processes.
What You Need to Learn
Q: Can I change the API name of a flow that is used in a process builder?
A: Yes, you can change the API name of a flow that is used in a process builder. However, you need to update the process builder to use the new API name.
Q: What happens if I change the API name of a flow that is used in a custom component?
A: If you change the API name of a flow that is used in a custom component, you need to update the custom component to use the new API name.
Q: Can I change the API name of a flow that is used in a managed package?
A: No, you cannot change the API name of a flow that is used in a managed package.
