Rule.io SDK

---

Rule.io SDK / client/src / CreateAutomationEmailConfig

Interface: CreateAutomationEmailConfig

Defined in: client/src/orchestration.types.ts:19

Properties

brandStyleId?

optional brandStyleId?: number

Defined in: client/src/orchestration.types.ts:41

Rule.io brand style ID. When provided (without template), the SDK auto-fetches the brand style and builds editor-compatible RCML.

---

delayInSeconds?

optional delayInSeconds?: string

Defined in: client/src/orchestration.types.ts:28

---

description?

optional description?: string

Defined in: client/src/orchestration.types.ts:21

---

fromEmail?

optional fromEmail?: string

Defined in: client/src/orchestration.types.ts:27

---

fromName?

optional fromName?: string

Defined in: client/src/orchestration.types.ts:26

---

name

name: string

Defined in: client/src/orchestration.types.ts:20

---

preheader?

optional preheader?: string

Defined in: client/src/orchestration.types.ts:25

---

sections?

optional sections?: (RcmlSection | RcmlLoop | RcmlSwitch)[]

Defined in: client/src/orchestration.types.ts:47

RCML body children to include when using brandStyleId. Supports sections, loops, and switch blocks. If omitted or empty, a default placeholder content section is added automatically.

---

sendoutType?

optional sendoutType?: AutomationSendoutType

Defined in: client/src/orchestration.types.ts:34

Sendout type for the automation.

• 'marketing' — marketing emails (default)
• 'transactional' — order confirmations, receipts, etc.

---

subject

subject: string

Defined in: client/src/orchestration.types.ts:24

---

template?

optional template?: RcmlDocument

Defined in: client/src/orchestration.types.ts:36

Full RCML template document. Provide this OR brandStyleId, not both.

---

triggerType

triggerType: "segment" | "tag" | "event"

Defined in: client/src/orchestration.types.ts:22

---

triggerValue

triggerValue: string

Defined in: client/src/orchestration.types.ts:23