Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / client/src / CreateDefaultSmsCampaignParams

Interface: CreateDefaultSmsCampaignParams

Defined in: client/src/resources/campaigns/campaigns.types.ts:484

Options for CampaignsClient.createDefaultSmsCampaign.

Creates a complete SMS campaign with all its dependencies in one call: campaign → message → template → dynamic set.

Example ​

typescript
const result = await client.campaigns.createDefaultSmsCampaign();

Properties ​

message? ​

optional message?: Partial<CreateSmsCampaignMessagePayload>

Defined in: client/src/resources/campaigns/campaigns.types.ts:497

Optional overrides for the auto-created SMS message.

Currently supports utmCampaign and utmTerm. When omitted the message is created with no UTM parameters.

name? ​

optional name?: string

Defined in: client/src/resources/campaigns/campaigns.types.ts:488

Initial campaign name. Defaults to a generated name when omitted.

sendoutType? ​

optional sendoutType?: CampaignSendoutType

Defined in: client/src/resources/campaigns/campaigns.types.ts:490

Sendout type. Defaults to 'marketing'.

template? ​

optional template?: object

Defined in: client/src/resources/campaigns/campaigns.types.ts:504

Optional overrides for the auto-created SMS template.

Provide name to override the auto-generated template name. Provide content to supply a custom SMS document.

content? ​

optional content?: SmsDocument

Custom SMS document. When omitted the SDK wraps the resolved SMS body text in a default SMS document.

name? ​

optional name?: string

Template name. When omitted the API assigns a default name automatically.

unsubscriptionMethod? ​

optional unsubscriptionMethod?: "unsubscribeLink" | "stopWord"

Defined in: client/src/resources/campaigns/campaigns.types.ts:523

Unsubscription method to include in the auto-generated SMS body footer.

  • 'unsubscribeLink' (default) — appends ::unsubscribe.
  • 'stopWord' — appends the stop-word merge-tag placeholder.

Has no effect when template.content is provided (the footer is then the caller's responsibility) or when sendoutType is 'transactional' (transactional campaigns do not include an unsubscription footer).