Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / client/src / CreateDefaultSmsMessageParams

Interface: CreateDefaultSmsMessageParams

Defined in: client/src/resources/automations/automations.types.ts:291

Options for AutomationsClient.createDefaultSmsMessage.

Example ​

typescript
const setup = await client.automations.createDefaultSmsMessage(automationId);
console.log(setup.messageId, setup.templateId, setup.dynamicSetId);

Properties ​

message? ​

optional message?: Partial<CreateSmsAutomationMessagePayload>

Defined in: client/src/resources/automations/automations.types.ts:298

Optional overrides for the auto-created SMS message.

Any field provided here replaces the default. See CreateSmsAutomationMessagePayload for available fields.

sendoutType? ​

optional sendoutType?: AutomationSendoutType

Defined in: client/src/resources/automations/automations.types.ts:327

Sendout type of the parent automation — used to decide whether to include an unsubscription footer. Defaults to 'marketing'.

template? ​

optional template?: object

Defined in: client/src/resources/automations/automations.types.ts:306

Optional overrides for the auto-created SMS template.

Provide content to supply a custom SMS document — this skips the default body generation entirely. Provide name to override the auto-generated template name.

content? ​

optional content?: SmsDocument

Custom SMS document. When omitted a default body is generated.

name? ​

optional name?: string

Template name. Defaults to 'Automation ${id} SMS template'.

unsubscriptionMethod? ​

optional unsubscriptionMethod?: "unsubscribeLink" | "stopWord"

Defined in: client/src/resources/automations/automations.types.ts:322

Unsubscription method included 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 automations do not include an unsubscription footer).