The updateEmailAction() GraphQL mutation may be used to update an email action in LogScale.

For more information on creating email actions, see the Action Type: Email documentation page. You may also want to look at the Actions page for related information.

Syntax

Below is the syntax for the updateEmailAction() mutation field:

graphql
updateEmailAction(
     input: UpdateEmailAction!
   ): EmailAction!

Given Datatypes

For the given datatype, updateEmailAction(), there are several parameters that may be given. Below is a list of them along with their datatypes and a description of each:

Table: UpdateEmailAction

ParameterTypeRequiredDefaultDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 23, 2024
attachCsvboolean  Whether the result set should be be attached as a CSV file.
bodyTemplatestring  Body of the email. Can be templated with values from the result.
idstringyes The unique identifier of the action.
namestringyes The name of the action.
recipients[string]yes List of email addresses where to send an email.
subjectTemplatestring  Subject of the email. Can be templated with values from the result.
useProxybooleanyes Defines whether the action should use the configured proxy to make web requests.
viewNamestringyes The name of the view of the action.

Returned Datatypes

The returned datatype EmailAction has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: EmailAction

ParameterTypeRequiredDefaultDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
allowedActions[AssetAction]yes The allowed asset actions. See AssetAction. This is a preview feature. Changes may occur.
attachCsvbooleanyes Whether the result set should be attached as a CSV file.
bodyTemplatestring  Body of the email. Can be templated with values from the result.
displayNamestringyes The display name of the action.
idstringyes The unique identifier of the action.
isAllowedToRunbooleanyes False if this type of action is disabled because of a security policy.
namestringyes The name of the action.
packagePackageInstallation  The package which the action is part. See PackageInstallation.
recipients[string]yes List of email addresses to send an email.
requiresOrganizationOwnedQueriesPermissionToEditbooleanyes True 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.
subjectTemplatestring  Subject of the email. Can be templated with values from the result.
useProxybooleanyes Defines whether the action should use the configured proxy to make web requests.
yamlTemplateyamlyes A template that can be used to recreate the action.