RecordActionDeployment

Represents configuration settings for the Actions & Recommendations, Action Launcher, and Bulk Action Panel components. RecordActionDeployment is available in API version 45.0 and later.

Version 

Introduced in API version 45.0.

Supported SOAP API Calls 

create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Fields 

ComponentName 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Introduced: API version 56.0

• Description: Specifies the name of the component used in the deployment.

For example, a value of 1 indicates that 1 is stored in the database if Action Launcher is used to create a deployment. Available in API version 56.0 and later.

• Possible values:

  • ActionsAndRecommendations — Actions and Recommendations — 0

  • ActionLauncher — Action Launcher — 1

  • BulkActionPanel — Bulk Action Panel — 2. This value is available in API version 60.0 and later.

DeveloperName 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: A unique name for this record action deployment. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. Provides a globally unique identifier for the record action deployment, which prevents conflicts with other record action deployments that have the same MasterLabel.

  Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.

  Note

FullName 

• Type: string

• Required: No

• Properties: Create, Group, Nillable

• Introduced: API version 45.0

• Description: The unique name used as the record action deployment identifier for API access. The fullName can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

HasComponents 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Introduced: API version 61.0

• Description: Indicates whether the record actions deployment includes components (true) or not (false).

• Default value: false

HasGuidedActions 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Introduced: API version 46.0

• Description: If true, indicates that the component shows standard actions; for example, flows and quick actions.

• Default value: false

HasOmniscripts 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Introduced: API version 56.0

• Description: Indicates whether the record actions deployment includes OmniScripts (true) or not (false).

The default value is false.

• Default value: false

HasRecommendations 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Introduced: API version 46.0

• Description: If true, indicates that the component shows recommendations from a Next Best Action strategy.

• Default value: false

Language 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

• Description: The language of the record action deployment. The following values are supported:

• Chinese (Simplified): zh_CN

• Chinese (Traditional): zh_TW

• Danish: da

• Dutch: nl_NL

• English: en_US

• Finnish: fi

• French: fr

• German: de

• Italian: it

• Japanese: ja

• Korean: ko

• Norwegian: no

• Portuguese (Brazil): pt_BR

• Russian: ru

• Spanish: es

• Spanish (Mexico): es_MX Spanish (Mexico) defaults to Spanish for customer-defined translations.

• Swedish: sv

• Thai: th The Salesforce user interface is fully translated to Thai, but Help is in English.

• Possible values:

  • en_US — English

  • de — German

  • es — Spanish

  • fr — French

  • it — Italian

  • ja — Japanese

  • sv — Swedish

  • ko — Korean

  • zh_TW — Chinese (Traditional)

  • zh_CN — Chinese (Simplified)

  • pt_BR — Portuguese (Brazil)

  • nl_NL — Dutch

  • da — Danish

  • th — Thai

  • fi — Finnish

  • ru — Russian

  • es_MX — Spanish (Mexico)

  • no — Norwegian

ManageableState 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Description: Indicates the manageable state of the specified component that is contained in a package:

• beta

• deleted

• deprecated

• deprecatedEditable

• installed

• installedEditable

• released

• unmanaged

• Possible values:

  • beta — beta

  • deleted — deleted

  • deprecated — deprecated

  • deprecatedEditable — deprecatedEditable

  • installed — installed

  • installedEditable — installedEditable

  • released — released

  • unmanaged — unmanaged

MasterLabel 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: The name of the deployment.

Metadata 

• Type: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Introduced: API version 45.0

• Description: Metadata that defines record action deployments.

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

NamespacePrefix 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The namespace prefix associated with the record action deployment, which is assigned to the AppExchange package. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. The namespace helps differentiate custom objects and fields from those in use by other record action deployments.