EmailAction is a datatype for an email action.

Table: EmailAction

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 30, 2025
allowedActions[AssetAction]yes Short-TermThe allowed asset actions. See AssetAction . This is a preview feature. Changes may occur.
attachCsvbooleanyes Long-TermWhether the result set should be attached as a CSV file.
bodyTemplatestring  Long-TermBody of the email. Can be templated with values from the result.
createdInfoAssetCommitMetadata  Long-TermMetadata related to the creation of the action. See AssetCommitMetadata.
displayNamestringyes Long-TermThe display name of the action.
idstringyes Long-TermThe unique identifier of the action.
isAllowedToRunbooleanyes Long-TermFalse if this type of action is disabled because of a security policy.
labels[string]  PreviewThe labels associated with the action, if any.
modifiedInfoAssetCommitMetadata  Long-TermMetadata related to the latest modification of the action. See AssetCommitMetadata.
namestringyes Long-TermThe name of the action.
packagePackageInstallation  Long-TermThe package which the action is part. See PackageInstallation.
packageIdVersionedPackageSpecifier  Long-TermThe package version. VersionedPackageSpecifier is a scalar.
recipients[string]yes Long-TermList of email addresses to send an email.
requiresOrganizationOwnedQueriesPermissionToEditbooleanyes Long-TermTrue if this action is used by triggers, where the query is run by the organization. If true, then the OrganizationOwnedQueries permission is required to edit the action.
resourcestringyes Short-TermThe resource identifier for the action.
subjectTemplatestring  Long-TermSubject of the email. Can be templated with values from the result.
useProxybooleanyes Long-TermDefines whether the action should use the configured proxy to make web requests.
yamlTemplateYAMLyes Long-TermA template that can be used to recreate the action. YAML is a scalar.