Rule.io SDK

---

Rule.io SDK / client/src / SetSmsAutomationPayload

Type Alias: SetSmsAutomationPayload

SetSmsAutomationPayload = SetEmailAutomationPayload

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

Payload for AutomationsClient.setSmsAutomation (full replacement).

All four fields are required — the API replaces the entire automation body. The message type is fixed to 'text_message' by the method.

Example

await client.automations.setSmsAutomation(automationId, {
  name: 'Order shipped SMS',
  active: true,
  trigger: { type: 'TAG', id: tagId },
  sendoutType: 'transactional',
});