Skip to content

Rule.io SDK


Rule.io SDK / client/src / AutomailSetting

Interface: AutomailSetting

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

Automail delivery settings attached to an automation message.

Controls when the automation fires relative to its trigger event.

Properties

active

active: boolean

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

Whether this automation message is active.

Set to false to pause the automation without deleting it.


delayInSeconds

delayInSeconds: string

Defined in: client/src/resources/messages/messages.types.ts:167

Delay between the trigger event and the send, expressed in seconds.

Pass "0" for immediate delivery. The API only supports simple delays via the API; custom delay logic requires the Rule.io UI.

The SDK accepts a string to avoid precision loss on large values and converts to an integer before sending to the API.