--- schema_version: "1" id: fae2973db9927791adcffb4c58cb698f3cf232483eca871d7dfb1fcc8654d130 title: AutomatedAction collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_automatedaction.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_automatedaction.htm source_site: developer.salesforce.com content_type: documentation content_hash: 1d4ebea355e109198278313f2ed011661aaf27fc8d25246bb094b3e5dce31bd5 description: Represents the configuration of an automated action, such as a workflow rule. This object is available in API version 57.0 and later. --- # AutomatedAction Represents the configuration of an automated action, such as a workflow rule. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | ApiVersion | Type int Properties Filter, Group, Sort Description Required. API version to use for executing the automated action. | | Description | Type textarea Properties Create, Nillable, Update Description Description of the automated action. | | ErrorDetail | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The source of the error encountered when executing the automated action. Possible values are: - invalidCondition - invalidConditionReference - invalidConditionValue - invalidInvocableAction - invalidInvocableActionParam - invalidReferenceEntity - unknownError | | ErrorMessage | Type textarea Properties Create, Nillable, Update Description A description of the error encountered when executing the automated action. | | EvalType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description When the automated action runs. Possible values are: - OnCreate - OnCreateAndUpdate | | ExecutionType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Whether the action runs automatically or generates a reminder. Possible values are: - Automatic - Reminder | | ExtraFilterExpression | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Additional condition logic for cross-object filters. | | ExtraFilterType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Additional criteria for cross-object filters. Possible values are: - Advanced - And - Or | | FilterExpression | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description If FilterType is Advanced, this field contains the condition logic. | | FilterType | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Criteria for filters. Possible values are: - Advanced - And - Or | | InvocationName | Type string Properties Create, Filter, Group, Sort, Update Description Invocable action to execute. | | IsLocked | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the automated action record is locked or not. The default value is false. | | LastEditedDateTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The timestamp when the automated action had a change that impacted rule evaluation. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, this record was likely referenced (LastReferencedDate) and not viewed. | | MayEdit | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the automated action record can be edited or not. The default value is false. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the automated action. | | ReferenceEntity | Type string Properties Create, Filter, Group, Sort, Update Description Entity on which the automated action operates. | | RuleType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of workflow rule. Possible values are: - ManagerAssigned - ManagerSubscribed - Personal - SdrAgent | | State | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The status of the alert. Possible values are: - Active - Error - Inactive | | SubscriptionState | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description For users who don’t have an override, the default value of the subscription. Possible values are: - Active - Inactive | | Summary | Type string Properties Filter, Nillable, Sort Description A human-readable explanation of the automated action, its conditions, and its parameters. | ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. [AutomatedActionOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [AutomatedActionShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object.