Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / client/src / CreateSmsTemplatePayload

Interface: CreateSmsTemplatePayload

Defined in: client/src/resources/templates/templates.types.ts:151

Payload for TemplatesClient.createSmsTemplate.

The message type is fixed to 'text_message' by the method. Construct the content document with createSmsDocument from @rule/rcml.

Example ​

typescript
import { createSmsDocument } from '@rule/rcml';

const template = await client.templates.createSmsTemplate({
  name: 'Order shipped SMS',
  content: createSmsDocument({ content: 'Your order has shipped!' }),
});

Properties ​

content ​

content: SmsDocument

Defined in: client/src/resources/templates/templates.types.ts:159

The SMS document defining the template body.

name? ​

optional name?: string

Defined in: client/src/resources/templates/templates.types.ts:157

Human-readable name for the template.

When omitted the API assigns a default name automatically.