Package Version Header

The Package Version header is a request header applied when working with managed packages. Use this header to specify the version of each package referenced by your API client. A package version is a number that identifies the set of components and behavior contained in a package. Publishers can use package versions to evolve the components in their managed packages gracefully by releasing subsequent package versions without breaking existing customer integrations using the package.

This header can also be used to specify a package version when making calls to an Apex REST web service.

The Package Version header can be used with the following resources: Describe Global, SObject Describe, SObject Basic Information, SObject Rows, SObject Layouts, Query, QueryAll, Search, and SObject Rows by External ID.

Header Field Name and Values

Field name and value

x-sfdc-packageversion-[namespace]: xx.x, where [namespace] is the unique namespace of the managed package and xx.x is the package version.

Example

x-sfdc-packageversion-clientPackage: 1.0