Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / client/src / AccountSenderDetails

Interface: AccountSenderDetails

Defined in: client/src/resources/account/account.types.ts:17

Account sender details as returned by GET /sender/details.

Contains the account-level email and SMS sender configuration.

Properties ​

accountId ​

accountId: number

Defined in: client/src/resources/account/account.types.ts:19

Account ID.

company ​

company: string

Defined in: client/src/resources/account/account.types.ts:25

Company name.

email ​

email: string

Defined in: client/src/resources/account/account.types.ts:23

Sender email address.

linkInsteadOfStopWord? ​

optional linkInsteadOfStopWord?: boolean

Defined in: client/src/resources/account/account.types.ts:34

Whether to use an unsubscribe link instead of a stop-word in SMS messages.

When true, the default SMS template should include a link-based unsubscribe. When false or omitted, a stop-word is used instead.

name ​

name: string

Defined in: client/src/resources/account/account.types.ts:21

Sender display name for emails.

textMessageSenderName ​

textMessageSenderName: string

Defined in: client/src/resources/account/account.types.ts:27

SMS sender name (the From field for text messages).