Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / client/src / AutomailSettingRead

Type Alias: AutomailSettingRead

AutomailSettingRead = { active: boolean; delayInSeconds: string; type: "delay"; } | { active: boolean; type: "custom"; }

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

Automail delivery state as returned by the Rule.io v3 API on automation messages.

Discriminated union on type. AutomailSetting (the write payload) is the flat shape the API accepts on create/update; on read, the API projects delivery state into this union.

  • "delay" — trigger-relative delay in seconds. Carries delayInSeconds ("0" for immediate delivery).
  • "custom" — date-based delivery configured in the Rule.io UI (e.g. "send N days before/after a subscriber's date field"). The API does not expose the underlying rules (which custom field, offset, direction, timezone, repeat behaviour), so the SDK can only report that a custom delay is set and whether the message is active. To view or modify a custom delay, use the Rule.io UI.

Union Members ​

Type Literal ​

{ active: boolean; delayInSeconds: string; type: "delay"; }

active ​

active: boolean

Whether this automation message is active.

delayInSeconds ​

delayInSeconds: string

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

"0" means the message is sent as soon as the trigger fires. Returned as a string to match the SDK's write-side AutomailSetting shape.

type ​

type: "delay"

Trigger-relative delay.

Type Literal ​

{ active: boolean; type: "custom"; }

active ​

active: boolean

Whether this automation message is active.

type ​

type: "custom"

Segment-driven delivery configured in the Rule.io UI.