--- schema_version: "1" id: 9012f9da91c8b69e4c33cedb84934b8e511ca6f0557a9d5d8003044dc367a413 title: QuickAction collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_quickaction.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_quickaction.htm source_site: developer.salesforce.com content_type: documentation content_hash: 3c8dc86296705085e8514a2a6b1313c5202fe92cb43d87f67b3a6360334ca8f9 description: Represents a specified create or update quick action for an object that then becomes available in the Chatter publisher. For example, you can create an action that, on the detail page of an account, allows a user to create a contact related to that account from the Chatter feed on that page. QuickAction can be created on objects that permit custom fields. --- # QuickAction Represents a specified create or update quick action for an object that then becomes available in the Chatter publisher. For example, you can create an action that, on the detail page of an account, allows a user to create a contact related to that account from the Chatter feed on that page. QuickAction can be created on objects that permit custom fields. The parent objects supported include: - Account - Campaign - Case - Contact - ContentNote - Custom objects - Group - Lead - Opportunity ## File Suffix and Directory Location QuickAction components have the suffix quickAction and are stored in the quickActions folder. ## Version QuickAction components are available in API version 28.0 and later. ## Fields
Field Name Field Type Description
actionSubtype ActionSybtype (enumeration of type string) The subtype of the action.
The valid values are:
  • Action—This value is available only for actions of type LightningWebComponent.
  • Create—The Quick Action Page defines the field layout of the record creation form. This value is available only for actions of type Flexipage. (This value is available as a Beta in API version 68.0 and later)
  • ScreenAction—This value is available only for actions of type LightningWebComponent.
  • Update—The Quick Action Page defines the field layout of the record update form. This value is available only for actions of type Flexipage. (This value is available as a Beta in API version 68.0 and later)

This field is available in API version 50.0 and later.
canvas string If the custom action invokes a Canvas app, the app name. Returns the fully qualified name of the Canvas app in the format <namespace>__<dev_name>, if the quick action type is Canvas; otherwise, returns null.

This field is available in API version 29.0 and later.
description string The description of the action.
fieldOverrides FieldOverride[] The specific field that can be overridden within a QuickAction.
flexiPage string The API name of the Quick Action Page that contains the fields and layout for the action. This field applies only when the quick action type is Flexipage.

This field is available as a Beta in API version 68.0 and later.
flowDefinition string If the custom action invokes a flow, this field represents the API name of the flow. Otherwise, this field is null.
height int If a custom action is created, this field represents the height in pixels of the action pane.
icon string The icon used to identify the action.

API version 32.0 and later returns different icons than in earlier API versions.
isProtected boolean Indicates whether this component is protected (true) or not (false). Protected components cannot be linked to or referenced by components created in the installing organization.
label string Identifies the action and displays to users. Also the default identifier used for the API and managed packages.
lightningComponent string If the custom action invokes a Lightning component, this field represents the fully qualified name of the component. Otherwise, this field is null.

Available in API version 38.0 and later.
optionsCreateFeedItem boolean Required. Indicates whether successful completion of the action creates a feed item (true) or not (false). Applies only to Create Record, Update Record, and Log a Call quick action types.

Available in API version 36.0 and later.
page string If the custom action invokes a Visualforce page, this field identifies the page.
quickActionLayout QuickActionLayout The layout of fields on the action.
quickActionParameters QuickActionParameter[] The input and output of the quick action.

Available in API version 63.0 and later.
standardLabel QuickActionLabel (enumeration of type string) Specifies the standard label to use for the action. The valid values are:
  • AddRecord
  • AddMember
  • ChangeDueDate
  • ChangePriority
  • ChangeStatus
  • CreateNew
  • CreateNewRecordType (For example, a label with something like “Create New Idea”)
  • Defer
  • EditDescription
  • EnrollInProgram (Available in API versions 46.0 and later only if the org has Health Cloud enabled)
  • Escalate
  • EscalateToRecord
  • Forward (Available in API version 42.0 and later)
  • LogACall
  • LogANote
  • ModifyAppointment (Available in API version 47.0 and later)
  • New (A new record)
  • NewChild (A new child record)
  • NewChildRecordType
  • NewRecordType (For example, a label with something like “New Idea”)
  • OfferFeedback
  • PatientDetails (Available in API version 57.0 and later if the org has Health Cloud enabled)
  • PerformCount (Available in API version 63.0 and later.)
  • Quick (A quick record)
  • QuickRecordType
  • RelocateAsset (Available in API version 63.0 and later)
  • ReplaceAsset (Available in API version 63.0 and later)
  • Reply (Available in API version 42.0 and later)
  • ReplyAll (Available in API version 42.0 and later)
  • RequestFeedback
  • SendEmail (This value is available in API version 31.0 and later.)
  • Update
successMessage string The message that displays to the user upon successful completion of the action.

Available in API version 36.0 and later.
targetObject string The object for which the action is created and performed.

For example, you can create an action that, on the detail page of an account, allows a user to create a contact related to that account from the Chatter feed on that page. QuickAction can be created on objects that permit custom fields. In this case, Contact is the targetObject.

targetParentField string The parent object type of the action. Links the target object to the parent object. For example, use Account if the target object is Contact and the parent object is Account.
targetRecordType string Specifies which record type to create. Valid values are:
  • Business Account
  • Person Account
  • Master
type QuickActionType (enumeration of type string) Required. The type of quick action. Valid values are:
  • Canvas
  • Create
  • Flexipage (This value is available as a Beta in API version 68.0 and later)
  • Flow (This value is available as a Beta in API version 41.0 and later)
  • LightningComponent (This value is available in API version 38.0 and later.)
  • LightningWebComponent
  • LogACall
  • Post
  • SendEmail (This value is available in API version 31.0 and later.)
  • SocialPost
  • Update
  • VisualforcePage
width int If a custom action is created, this field represents the width in pixels of the action pane.
## FieldOverride Represents the field names and their respective formulas and literal values that comprise predefined value settings for a [QuickAction](#meta_quickaction "Represents a specified create or update quick action for an object that then becomes available in the Chatter publisher. For example, you can create an action that, on the detail page of an account, allows a user to create a contact related to that account from the Chatter feed on that page. QuickAction can be created on objects that permit custom fields."). If a field on an action has both a predefined value and a default value set, the action uses the predefined value, not the default value. A formula value takes precedence over a literal value if both are defined. | Field Name | Field Type | Description | | --- | --- | --- | | field | string | Required. The name of the field to allow predefined values on. | | formula | string | Specifies the formula to use when setting a field’s predefined value. Supported for single-select picklists as of API version 43.0. | | literalValue | string | Supported for picklists only. Specifies the literal value of the field defined from values in the picklist. Corresponds to the Specific Value field in the predefined value UI. | ## QuickActionLayout The layout of fields on the action. There’s no hard limit to the number of fields you can add to an action layout. However, for optimum usability, we recommend a maximum of eight fields. Adding more than 20 fields can severely affect user efficiency.
Field Name Field Type Description
layoutSectionStyle LayoutSectionStyle (enumeration of type string) Required. The type of layout structure used. The valid values are:
  • TwoColumnsTopToBottom
  • TwoColumnsLeftToRight
  • OneColumn
  • CustomLinks
quickActionLayoutColumns QuickActionLayoutColumn[] Specifies columns in a QuickActionLayout.
## QuickActionLayoutColumn A column defined for a [QuickActionLayout](#quickActionLayout_title). | Field Name | Field Type | Description | | --- | --- | --- | | quickActionLayoutItems | [QuickActionLayoutItem](#quickActionLayoutItem_title) \[\] | Specifies row items in a [QuickActionLayoutColumn](#quickActionLayoutColumn_title). | ## QuickActionLayoutItem A row item comprised of fields and defined for a [QuickActionLayoutColumn](#quickActionLayoutColumn_title).
Field Name Field Type Description
emptySpace boolean Controls if this layout item is a blank space (true) or not (false).
field string Represents a specific field in QuickActionLayoutItem.
uiBehavior UiBehavior (enumeration of type string) Specifies user input behavior for specific fields in QuickActionLayoutItem. The valid values are:
  • Edit
  • Required
  • Readonly
## QuickActionParameter Represents the input and output of the associated quick action. Available in API version 63.0 and later. | Field Name | Field Type | Description | | --- | --- | --- | | name | string | Required. Name of the parameter. | | type | QuickActionParameterType ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string) | Required. Input is the only valid value. | | value | string | Represents the value associated with the given parameter name. | ## Declarative Metadata Sample Definition The following is an example of a [QuickAction](#meta_quickaction "Represents a specified create or update quick action for an object that then becomes available in the Chatter publisher. For example, you can create an action that, on the detail page of an account, allows a user to create a contact related to that account from the Chatter feed on that page. QuickAction can be created on objects that permit custom fields.") component: testActionDefinitionTypesCreateTask testActionDefinitionTypesCreateTask true TwoColumnsLeftToRight false OwnerId Required false WhoId Edit false WhatId Edit false ActivityDate Edit false Subject Edit false Status Required false Priority Required This is a success message Task What Create ## Wildcard Support in the Manifest File This metadata type supports the wildcard character \* (asterisk) in the package.xml manifest file. For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).