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:499

Optional overrides for the auto-created SMS message.

Any field provided here replaces the default. subject (the SMS body text) defaults to a placeholder with an unsubscribe footer; the footer style (link vs stop-word) is determined from the account's sender configuration, fetched automatically when subject is omitted.

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:506

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. Defaults to 'Campaign ${id} SMS template'.