Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / client/src / UpdateEmailAutomationMessagePayload

Interface: UpdateEmailAutomationMessagePayload

Defined in: client/src/resources/messages/messages.types.ts:347

Payload for MessagesClient.updateEmailAutomationMessage.

All fields are optional — only the fields you include are changed. Automation messages additionally support updating the automail delivery settings via automailSetting. Use UpdateEmailCampaignMessagePayload for campaign messages.

Example ​

typescript
await client.messages.updateEmailAutomationMessage(messageId, {
  subject: 'Welcome — updated copy',
  automailSetting: { active: true, delayInSeconds: '3600' },
});

Properties ​

automailSetting? ​

optional automailSetting?: AutomailSetting

Defined in: client/src/resources/messages/messages.types.ts:361

New automail delivery settings. Omit to leave unchanged.

fromEmail? ​

optional fromEmail?: string | null

Defined in: client/src/resources/messages/messages.types.ts:355

New from address. Pass null to clear.

fromName? ​

optional fromName?: string | null

Defined in: client/src/resources/messages/messages.types.ts:353

New sender display name. Pass null to clear.

preheader? ​

optional preheader?: string | null

Defined in: client/src/resources/messages/messages.types.ts:351

New preheader text. Pass null to clear.

subject? ​

optional subject?: string

Defined in: client/src/resources/messages/messages.types.ts:349

New subject line.

utmCampaign? ​

optional utmCampaign?: string | null

Defined in: client/src/resources/messages/messages.types.ts:357

New UTM campaign parameter. Pass null to clear.

utmTerm? ​

optional utmTerm?: string | null

Defined in: client/src/resources/messages/messages.types.ts:359

New UTM term parameter. Pass null to clear.