Rule.io SDK

---

Rule.io SDK / client/src / UpdateSmsAutomationMessagePayload

Interface: UpdateSmsAutomationMessagePayload

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

Payload for MessagesClient.updateSmsAutomationMessage.

All fields are optional — only the fields you include are changed.

Example

await client.messages.updateSmsAutomationMessage(messageId, {
  subject: 'Hi {{Subscriber.FirstName}}, your order shipped!',
  automailSetting: { active: true, delayInSeconds: '3600' },
});

Properties

automailSetting?

optional automailSetting?: AutomailSetting

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

New automail delivery settings. Omit to leave unchanged.

---

subject?

optional subject?: string

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

New SMS message body text.

---

utmCampaign?

optional utmCampaign?: string | null

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

New UTM campaign parameter. Pass null to clear.

---

utmTerm?

optional utmTerm?: string | null

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

New UTM term parameter. Pass null to clear.