Rule.io SDK

---

Rule.io SDK / client/src / CreateEmailCampaignPayload

Interface: CreateEmailCampaignPayload

Defined in: client/src/resources/campaigns/campaigns.types.ts:177

Payload for CampaignsClient.createEmailCampaign.

The message type is fixed to 'email' by the method — do not include it here. A campaign starts with no name and no recipients; add those with CampaignsClient.update before scheduling.

Example

const campaign = await client.campaigns.createEmailCampaign({
  sendoutType: 'marketing',
});

Properties

name?

optional name?: string

Defined in: client/src/resources/campaigns/campaigns.types.ts:179

Campaign name. Defaults to a generated name if omitted.

---

segments?

optional segments?: CampaignRecipientSegment[]

Defined in: client/src/resources/campaigns/campaigns.types.ts:190

Initial segment recipient filters.

---

sendoutType?

optional sendoutType?: CampaignSendoutType

Defined in: client/src/resources/campaigns/campaigns.types.ts:186

Sendout type.

'marketing' = standard marketing email (default). 'transactional' = triggered transactional email.

---

subscribers?

optional subscribers?: number[]

Defined in: client/src/resources/campaigns/campaigns.types.ts:192

Initial individual subscriber IDs.

---

tags?

optional tags?: CampaignRecipientTag[]

Defined in: client/src/resources/campaigns/campaigns.types.ts:188

Initial tag recipient filters.