Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / client/src / CreateSmsAutomationMessagePayload

Interface: CreateSmsAutomationMessagePayload

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

Payload for MessagesClient.createSmsAutomationMessage.

The subject field holds the SMS message body text. SMS messages do not have sender, preheader, or from-email fields.

Example ​

typescript
await client.messages.createSmsAutomationMessage(automationId, {
  subject: 'Hi {{Subscriber.FirstName}}, your order has shipped!',
  automailSetting: { active: true, delayInSeconds: '0' },
});

Properties ​

automailSetting? ​

optional automailSetting?: AutomailSetting

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

Automail delivery settings for this message.

Omitting this field leaves the setting unchanged on update, or uses the API default (active, no delay) on create.

subject ​

subject: string

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

SMS message body text. Required.

utmCampaign? ​

optional utmCampaign?: string | null

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

UTM campaign parameter appended to tracked links.

utmTerm? ​

optional utmTerm?: string | null

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

UTM term parameter appended to tracked links.