Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / client/src / CreateSmsCampaignMessagePayload

Interface: CreateSmsCampaignMessagePayload

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

Payload for MessagesClient.createSmsCampaignMessage.

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.createSmsCampaignMessage(campaignId, {
  subject: 'Your order has shipped!',
});

Properties ​

subject ​

subject: string

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

SMS message body text. Required.

utmCampaign? ​

optional utmCampaign?: string | null

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

UTM campaign parameter appended to tracked links.

utmTerm? ​

optional utmTerm?: string | null

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

UTM term parameter appended to tracked links.