PackageInstallRequest

Represents a request to install a package (first- or second-generation) in a target subscriber org.

Version 

Introduced in API version 36.0.

Supported SOAP API Calls 

create(), describeSObjects(), query(), retrieve()

Supported REST API Methods 

GET, POST, Query

Fields 

ApexCompileType 

• Type: text

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 46.0

• Description: For unlocked package installs and upgrades, specifies whether to require successful compilation of all Apex in the org, or only Apex within the package.

Valid values are:

• all
• package

For package installs into production orgs, or any org that has Apex Compile on Deploy enabled, the platform compiles all Apex in the org after the package install or upgrade operation completes. This approach assures that package installs and upgrades don’t impact the performance of an org, and is done even if --apexcompile package is specified.

EnableRss 

• Type: boolean

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 43.0

• Description: Specifies whether the package can send and receive Remote Site Settings (RSS) and Content Security Policy (CSP) data from third-party websites (true) or not (false).

The default value is false.

NameConflictResolution 

• Type: staticenum

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: Controls name conflicts between package members in an unmanaged package.

PackageInstallSource 

• Type: staticenum

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: For internal use only.

Password 

• Type: text

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The installation key for the package. Required for packages that are protected by an installation key.

SecurityType 

• Type: staticenum

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: Users for which this package is installed.

SkipHandlers 

• Type: text

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 61.0

• Description: Specifies the handlers that are skipped when the package is installed.

There’s only one valid value:

• FeatureEnforcement: For package installs in scratch orgs only. Specifying FeatureEnforcement in this field decreases the length of time a package installation takes to complete.

The feature enforcement handler adds object and feature validations in the subscriber org that prevent an admin from turning off a feature that can cause your app to malfunction. This enforcement isn’t critical in scratch orgs.

Status 

• Type: staticenum

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The status of the install request.

SubscriberPackageVersionKey 

• Type: text

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: Foreign key to the subscriber package version.

UpgradeType 

• Type: text

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: For unlocked package upgrades, specifies whether to mark all removed components as deprecated (deprecate-only, delete removed components that can be safely deleted and deprecate the others (mixed-mode), or delete all removed components (delete-only). The default is mixed-mode. Valid values are:

• delete-only

• deprecate-only

• mixed-mode

SubscriberPackageInstallErrors 

Represents the list of errors that occurred during package installation.

Field	Details
errors	- Type - Description: The errors that occurred during package install.

SubscriberPackageInstallError 

Represents a single error that occurred during package installation.

Field	Details
message	- Type: string - Description: Required. Describes the error that occurred.

SubscriberPackageProfileMappings 

Represents the list of profile mappings for which this package is installed.

Field	Details
profileMappings	- Type - Description: Name of the profile mapping.

SubscriberPackageProfileMapping 

Represents a mapping between a profile in the package that’s being installed and the profile in the target subscriber org.

Field	Details
source	- Type: string - Description: Required. The name of the profile setting in the package that’s being installed.
target	- Type: string - Description: Required. The name of the profile in the target subscriber org.