Appearance
Rule.io SDK / client/src / AutomailSetting
Interface: AutomailSetting
Defined in: client/src/resources/messages/messages.types.ts:163
Automail delivery settings for the write path (POST / PUT).
Only trigger-relative delays can be set through the SDK: pass delayInSeconds as a string of seconds since the trigger event ("0" for immediate delivery). Date-based (UI-configured) delays cannot be created or modified through the SDK — configure them in the Rule.io UI.
Properties
active
active:
boolean
Defined in: client/src/resources/messages/messages.types.ts:169
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:179
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.