Rule.io SDK

---

Rule.io SDK / client/src / CreateCampaignEmailConfig

Interface: CreateCampaignEmailConfig

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

Configuration for creating a complete campaign email in one call.

Example

const result = await client.createCampaignEmail({
  name: 'April Newsletter',
  subject: 'What\'s new this month',
  sendoutType: 1,
  brandStyleId: 976,
  tags: [{ id: 42, negative: false }],
});

Properties

brandStyleId?

optional brandStyleId?: number

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

Brand style ID to auto-build editor-compatible RCML.

---

fromEmail?

optional fromEmail?: string

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

---

fromName?

optional fromName?: string

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

---

name

name: string

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

---

preheader?

optional preheader?: string

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

---

sections?

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

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

RCML body sections when using brandStyleId. Defaults to placeholder content when omitted or empty.

---

segments?

optional segments?: CampaignRecipientSegment[]

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

---

sendoutType?

optional sendoutType?: CampaignSendoutType

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

---

subject

subject: string

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

---

subscribers?

optional subscribers?: number[]

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

---

tags?

optional tags?: CampaignRecipientTag[]

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

---

template?

optional template?: RcmlDocument

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

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