Metadata API Developer Tools

The easiest way to access the functionality in Metadata API is to use the Salesforce Extensions for Visual Studio Code or Salesforce CLI. Both tools are built on top of Metadata API and use the standard tools to simplify working with Metadata API.

• The Salesforce Extensions for Visual Studio Code includes tools for developing on the Salesforce platform in the lightweight, extensible VS Code editor. These tools provide features for working with development orgs (scratch orgs, sandboxes, and DE orgs), Apex, Aura components, and Visualforce.
• Salesforce CLI is ideal if you use scripting or the command line for moving metadata between a local directory and a Salesforce org.

For more information about the Salesforce Extensions for Visual Studio Code or Salesforce CLI, see Salesforce Tools and Toolkits.

If you prefer to build your own client applications, the underlying calls of Metadata API have been exposed for you to use directly. This guide gives you more information about working directly with Metadata API.

You can use the Metadata API to manage setup and customization information (metadata) in Salesforce. For example:

• Export customizations as XML metadata files. See Working with the Zip File and retrieve().
• Migrate configuration changes between orgs. See deploy() and retrieve().
• Modify existing customizations using XML metadata files. See deploy() and retrieve().
• Manage customizations programmatically. See CRUD-Based Metadata Development.

You can modify metadata in test orgs in Developer Edition or sandboxes, and then deploy tested changes to production orgs in Enterprise, Unlimited, or Performance Editions. You can also create scripts to populate a new org with your custom objects, custom fields, and other components.