Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / client/src / CreateSmsCampaignMessagePayload

Interface: CreateSmsCampaignMessagePayload

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

Payload for MessagesClient.createSmsCampaignMessage.

SMS messages do not have sender, preheader, or from-email fields. All fields are optional — the API applies account-level defaults when omitted.

Example ​

typescript
await client.messages.createSmsCampaignMessage(campaignId, {
  utmCampaign: 'spring-sale',
});

Properties ​

utmCampaign? ​

optional utmCampaign?: string | null

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

UTM campaign parameter appended to tracked links.

utmTerm? ​

optional utmTerm?: string | null

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

UTM term parameter appended to tracked links.