QuickActionDefinition

Represents the definition of a quick action.

This object is available in API version 32.0 and later.

Supported SOAP Calls

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

Supported REST HTTP Methods

DELETE, GET, PATCH, POST

Fields

Field	Details
ActionSubtype	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The subtype of the action. Valid values are: `Action` `ScreenAction` This field is available in API version 50.0 and later. This field is available only for Lightning web component quick actions. Note
Description	Type textarea Properties Filter, Group, Nillable, Sort Description The description of the action.
DeveloperName	Type string Properties Filter, Group, Sort Description The unique name of the action in the API. This field corresponds to the Name field in the user interface. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. Note
EntityDefinitionId	Type string Properties Filter, Group, Nillable, Sort Description The ID of the object associated with the quick action. Relationship Name EntityDefinition Relationship Type Lookup Refers To EntityDefinition
FullName	Type string Properties Create, Group, Nillable Description The full name of the associated metadata object in Metadata API. 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.
Height	Type int Properties Filter, Group, Nillable, Sort Description The height of the action, in pixels. This field is set only when the quick action has a custom icon.
IconId	Type reference Properties Filter, Group, Nillable, Sort Description The ID of the action icon. This field is set only when the quick action has a custom icon. Relationship Name Icon Relationship Type Lookup Refers To StaticResource
Label	Type string Properties Filter, Group, Nillable, Sort Description The action label that corresponds to the Label field in the user interface.
Language	Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The language of the action. Valid values are: 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.
ManageableState	Type ManageableState enumerated list 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` This field is available in API version 38.0 and later.
MasterLabel	Type string Properties Filter, Group, Sort Description The action label.
Metadata	Type QuickAction Properties Create, Nillable, Update Description The metadata for the quick action. 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 Properties Filter, Group, Nillable, Sort Description The namespace of the action.
OptionsCreateFeedItem	Type boolean Properties Filter, Description 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.
SobjectType	Type picklist Properties Filter, Group, Restricted picklist, Sort Description The associated object’s API name. For example, `FeedItem`.
StandardLabel	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The standard label for the action. 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) `Quick` (A quick record) `QuickRecordType` `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	Type string Properties Filter, Group, Nillable, Sort Description The message that displays to the user upon successful completion of the action. Available in API version 36.0 and later.
TargetField	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The API name of the parent object for the record created by this quick action. For example, `CollaborationGroup`.
TargetRecordTypeId	Type reference Properties Filter, Group, Nillable, Sort Description The ID of the target record type. Relationship Name TargetRecordType Relationship Type Lookup Refers To RecordType
TargetSobjectType	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The API name of the type of object record this action creates. For example, `OpportunityLineItem`.
Type	Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of action. Valid values are: `Canvas` `Create` `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.) `LogACall` `Post` `SendEmail` `SocialPost` `Update` `VisualforcePage`
Width	Type int Properties Filter, Group, Nillable, Sort Description The width of the action, in pixels. This field is set only when the quick action has a custom icon.

Usage

A QuickActionDefinition represents information about a quick action. The following example creates a global quick action that lets users quickly create a task.

QuickActionDefinition qad = new QuickActionDefinition();
qad.setDeveloperName("MyQuickCreateTaskAction");
qad.setSobjectType("Global");
qad.setTargetSobjectType("Task");
qad.setMasterLabel("Quick create a task");
qad.setType(QuickActionType.Create);
qad.setDescription("Quickly creates a Task");

sforce.create(new SObject[]{qad});

Login

Products

Experiences

Agentforce

CRM Products

Industries

Small Business

Data

Salesforce Platform

Customer Success

Partner Apps & Experts

Discover the #1 AI CRM

Discover the #1 AI CRM

Automotive

Communications

Engineering, Construction & Real Estate

Consumer Goods

Education

Energy & Utilities

Financial Services

Healthcare & Life Sciences

Manufacturing

Media

Nonprofit

Professional Services

Public Sector

Retail

Technology

Travel, Transportation & Hospitality

Explore Salesforce for industries.

Explore Salesforce for industries.

Customer Stories

Salesforce on Salesforce Stories

Trailblazer Stories

Explore success stories.

Explore success stories.

Learning on Trailhead

Events

Resources

Blogs

Become a Trailblazer.

Become a Trailblazer.

Help & Documentation

Communities

Services & Plans

Account Management

Questions? We can help.

Questions? We can help.

About Salesforce

Our Values

Our Impact

Careers

Newsroom

Legal

More Salesforce Brands

Hear our story.

Hear our story.

Events

Original Series

My List

Explore Salesforce+.

Explore Salesforce+.

Login

Products

Experiences

Contact Us

By phone

Online

Products

Experiences

Developer Centers

Salesforce Platform

Industries

Resources

Developer Tools

Build Skills

Extend Salesforce

Stay Up To Date

Community

Tooling API