REST Resource: projects.locations.instances.emailTemplates

Resource: EmailTemplate

This service is available for customers who migrated SOAR to a customer managed project and have the Chronicle API enabled. EmailTemplate resource.

JSON representation
{
  "name": string,
  "templateType": enum (EmailTemplateType),
  "content": string,
  "displayName": string,
  "author": string,
  "environments": string
}
Fields
name

string

Identifier. The resource name of the EmailTemplate. Format: projects/{project}/locations/{location}/instances/{instance}/emailTemplates/{emailTemplate}

templateType

enum (EmailTemplateType)

Required. Type of the content

content

string

Required. Content of the EmailTemplate.

displayName

string

Required. Display name of the EmailTemplate.

author

string

Output only. Name of creator user.

environments

string

Required. The environments to which the custom list is associated.

EmailTemplateType

The resource inner type of the EmailTemplate.

Enums
EMAIL_TEMPLATE_TYPE_UNSPECIFIED unspecified value
TEMPLATE simple text content
HTML_FORMAT text content in HTML format

Methods

batchDelete

Batch delete email templates.

create

Creates an EmailTemplate for a given instance.

delete

Deletes an EmailTemplate for a given instance.

export

Export email templates as file stream.

get

Gets an EmailTemplate by name.

import

Import email templates from file stream.

list

Lists all EmailTemplates for a given instance.

patch

Updates an EmailTemplate for a given instance.