Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / client/src / UpdateEmailCampaignMessagePayload

Interface: UpdateEmailCampaignMessagePayload

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

Payload for MessagesClient.updateEmailCampaignMessage.

All fields are optional — only the fields you include are changed. Campaign messages do not have automail delivery settings; use UpdateEmailAutomationMessagePayload for automation messages.

Example ​

typescript
await client.messages.updateEmailCampaignMessage(messageId, {
  subject: 'Updated: Your order is on its way',
});

Properties ​

fromEmail? ​

optional fromEmail?: string | null

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

New from address. Pass null to clear.

fromName? ​

optional fromName?: string | null

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

New sender display name. Pass null to clear.

preheader? ​

optional preheader?: string | null

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

New preheader text. Pass null to clear.

subject? ​

optional subject?: string

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

New subject line.

utmCampaign? ​

optional utmCampaign?: string | null

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

New UTM campaign parameter. Pass null to clear.

utmTerm? ​

optional utmTerm?: string | null

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

New UTM term parameter. Pass null to clear.