Skip to main content

EmailTemplateCreateInput

Email template creation data with email-specific configuration.

Extends base template functionality with email-specific fields including subject lines, sender information, recipients, and attachment handling for comprehensive email template setup.

input EmailTemplateCreateInput {
  contents: [LocalizedTemplateContentInput!]!
  names: [LocalizedStringInput!]!
  customQuery: String
  queryVariables: String
  subjects: [LocalizedStringInput!]!
  from: EmailSenderInput!
  tos: [EmailContactInput!]
  ccs: [EmailContactInput!]
  bccs: [EmailContactInput!]
}

Fields​

EmailTemplateCreateInput.contents ● [LocalizedTemplateContentInput!]! non-null input​

Handlebars template content for each supported language.

The actual template markup using Handlebars syntax for dynamic content generation, stored per language for localization support.

Validation: Array must not be empty, must contain unique language entries.

EmailTemplateCreateInput.names ● [LocalizedStringInput!]! non-null input​

Localized template names for different languages.

Human-readable names for the template in various languages, used for template identification and management in multilingual environments.

Validation: Array must not be empty, must contain unique language entries.

EmailTemplateCreateInput.customQuery ● String scalar​

GraphQL query for additional data enrichment.

Custom query executed before template rendering to fetch supplementary data not included in the original event payload, enabling rich template content with external data sources.

EmailTemplateCreateInput.queryVariables ● String scalar​

Variables for custom GraphQL query execution.

JSON object containing variables used in the custom query, supports Handlebars expressions for dynamic variable generation based on event data. Only valid when customQuery is provided.

EmailTemplateCreateInput.subjects ● [LocalizedStringInput!]! non-null input​

Localized email subject lines with dynamic content support.

Email subject text for each language with Handlebars variable support for personalized subject lines based on recipient and context data.

Validation: Array must not be empty, must contain unique language entries.

EmailTemplateCreateInput.from ● EmailSenderInput! non-null input​

Email sender contact information.

Sender details including email address and display name used in the 'From' field of outgoing emails, supporting localized sender names for multilingual communications.

EmailTemplateCreateInput.tos ● [EmailContactInput!] list input​

Primary email recipient contact information.

List of primary recipients who will receive the email in their main inbox, visible to all recipients. Supports multiple identification methods including direct email addresses and system user references.

Validation: When provided, array must not be empty and must contain unique entries.

EmailTemplateCreateInput.ccs ● [EmailContactInput!] list input​

Carbon copy recipient contact information.

List of recipients who will receive a copy of the email, visible to all recipients in the 'CC' field for transparency. Useful for keeping stakeholders informed.

Validation: When provided, array must not be empty and must contain unique entries.

EmailTemplateCreateInput.bccs ● [EmailContactInput!] list input​

Blind carbon copy recipient contact information.

List of recipients who will receive a copy of the email without being visible to other recipients, maintaining privacy while ensuring necessary parties are informed.

Validation: When provided, array must not be empty and must contain unique entries.

Member Of​

emailTemplateCreate mutation