--- schema_version: "1" id: a1fa3d6f4737cea7ea47e14fbf9af38de98fdc63c0b7333d9af4f6be5a10a3f7 title: PackageInstallRequest collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_tooling/tooling_api_objects_packageinstallrequest.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_packageinstallrequest.htm source_site: developer.salesforce.com content_type: documentation content_hash: 59cc2670976c572052434170e70298c8adf496347fcef2421cd42ad060abff80 description: Represents a request to install a package (first- or second-generation) in a target subscriber org. Available in API version 41.0 and later. --- # PackageInstallRequest Represents a request to install a package (first- or second-generation) in a target subscriber org. Available in API version 41.0 and later. ## Supported SOAP Calls create(), describeSObjects(), query(), retrieve() ## Supported REST HTTP Methods GET, POST, Query ## Fields | Field | Details | | --- | --- | | ApexCompileType | Type string Properties Create, Filter, Group, Nillable, Sort 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_deploying.htm), 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. Available in API version 46.0 and later. | | EnableRss | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort 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. Available in API version 43.0 and later. | | Errors | Type [SubscriberPackageInstallErrors](#SubscriberPackageInstallErrors) Properties Nillable Description Errors that occurred during installation, if any. | | NameConflictResolution | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Controls name conflicts between package members in an unmanaged package. Valid values are: - Block: Throw an exception on name conflicts. - RenameMetadata: Rename only those components that can be renamed, otherwise throw an exception. | | PackageInstallSource | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description For internal use only. | | Password | Type string Properties Create, Filter, Group, Nillable, Sort Description The installation key for the package. Required for packages that are protected by an installation key. | | ProfileMappings | Type [SubscriberPackageProfileMappings](#SubscriberPackageProfileMappings) Properties Create, Nillable Description Mappings between [profile settings](https://developer.salesforce.com/docs/atlas.en-us.pkg1_dev.meta/pkg1_dev/packaging_creating_custom_profile.htm "HTML (New Window)") in the package and profiles in the subscriber org. When installing a package, the admin for the subscriber org chooses which profiles in the org to map the profile settings in the package to. | | SecurityType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Users for which this package is installed. Valid values are: - Custom: Installed for specified custom profiles. - Full: Installed for all users. - None: Installed for administrators only. | | SkipHandlers | Type string Properties Create, Filter, Group, Nillable, Sort 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. Available in API version 61.0 and later. | | Status | Type picklist Properties Group, Nillable, Restricted picklist, Sort Description The status of the install request. Valid values are: - Error - InProgress - Success - Unknown | | SubscriberPackageVersionKey | Type string Properties Create, Filter, Group, Sort Description Foreign key to the subscriber package version. | | UpgradeType | Type string Properties Create, 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 [SubscriberPackageInstallError](#SubscriberPackageInstallError) 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 [SubscriberPackageProfileMapping](#SubscriberPackageProfileMapping) 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. |