Skip to main content

EventToEmailConfigUpdateInput

Input for updating email event action configurations.

Extends base event action updates with email-specific fields. Only provided fields will be updated.

input EventToEmailConfigUpdateInput {
  names: [LocalizedStringInput!]
  trigger: EventTrigger
  code: String
  channelIds: [Int!]
  isDefault: Boolean
  emailTemplateId: String
}

Fields​

EventToEmailConfigUpdateInput.names ● [LocalizedStringInput!] list input​

Updated display names in multiple languages.

When provided, must contain at least one localized name. Each language entry must be unique and properly validated.

EventToEmailConfigUpdateInput.trigger ● EventTrigger enum​

System event that activates this action configuration.

Defines which event type will cause this automation to execute, enabling event-driven workflow processing.

EventToEmailConfigUpdateInput.code ● String scalar​

Updated custom event code for CUSTOM_EVENT triggers.

Maximum length of 64 characters. Used to identify which configurations to execute for custom events.

EventToEmailConfigUpdateInput.channelIds ● [Int!] list scalar​

Array of channel identifiers for filtering event action configurations.

Used to restrict event action configurations to specific communication channels. When omitted, returns all channels.

EventToEmailConfigUpdateInput.isDefault ● Boolean scalar​

Whether this configuration runs when an event of its trigger is not targeted at specific event actions.

When omitted, the current value is kept. A non-default configuration only runs when a send targets it by ID (eventActionConfigIds on the order and quote trigger mutations); on every other trigger, false means it never runs. Cannot be null.

EventToEmailConfigUpdateInput.emailTemplateId ● String scalar​

Updated email template identifier for message content.

Must be a valid UUID format referencing an existing email template in the system. The template defines the email content, subject, and formatting.

Member Of​

eventToEmailConfigUpdate mutation