Schema Update Support

You can register an updated schema version that includes supported changes to active and inactive components. This section provides details about whether changes are supported.

Supported

Adding:

  • Actions / Operations
  • Objects
  • Properties
  • Parameters

Deleting:

  • Operations: inactive operations
  • Parameters: required parameters from inactive operations
  • Parameters: optional parameters from active or inactive operations
  • Properties: required properties from inactive objects
  • Properties: optional properties from active or inactive objects

Deleting parameters or properties can lead to errors in flows, Apex, Agentforce agents, or other components that reference them. Inspect your integrations for any errors due to these changes.

Changing:

  • The description or example, which doesn't affect the name
  • Changing the casing of an operation, parameter, object or property name

To edit a registration, or to update a schema with a new version, see Manage External Services.

Not Supported

Deleting or omitting:

  • Active operations
  • Required parameters from active operations
  • Required properties from active objects
  • Objects that are referenced by active operations

Changing:

  • A name change is considered deleting the element with that name and adding the element with the new name.
  • A required property or required parameter type change is allowed only for inactive operations and objects.
  • An optional property or optional parameter type change is allowed. Errors can result in flows, Apex, Agentforce agents, or other components that reference them. Inspect your integrations for any errors due to type changes.