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: 

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

ParameterTypeRequired[a]DefaultDescription
viewNamestringyes The name of the view of the action.
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.
bodyTemplatestring  Body 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.
attachCsvboolean = false  Whether the result set should be be attached as a CSV file.

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.


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

ParameterTypeRequired[a]DefaultDescription
recipients[string]yes List of email addresses to send an email.
subjectTemplatestring  Subject of the email. Can be templated with values from the result.
bodyTemplatestring  Body 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.
attachCsvbooleanyes Whether the result set should be be attached as a CSV file.
namestringyes The name of the action.
displayNamestringyes The display name of the action.
idstringyes The unique identifier of the action.
yamlTemplateYAMLyes A template that can be used to recreate the action.
packagePackageInstallationyes The package, if any, of which the action is part (see PackageInstallation Table).

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.