Skip to content

Rule.io SDK


Rule.io SDK / client/src / RecipientSubscriber

Interface: RecipientSubscriber

Defined in: client/src/resources/recipients/recipients.types.ts:42

A subscriber as returned by the recipient targeting endpoint.

This is intentionally distinct from the main Subscriber entity — the recipients endpoint returns a lightweight shape optimised for targeting lookups rather than full subscriber management.

Properties ​

accountId? ​

optional accountId?: number

Defined in: client/src/resources/recipients/recipients.types.ts:48


createdAt? ​

optional createdAt?: string

Defined in: client/src/resources/recipients/recipients.types.ts:51


customIdentifier? ​

optional customIdentifier?: string | null

Defined in: client/src/resources/recipients/recipients.types.ts:47


email? ​

optional email?: string | null

Defined in: client/src/resources/recipients/recipients.types.ts:44


id ​

id: number

Defined in: client/src/resources/recipients/recipients.types.ts:43


language? ​

optional language?: string

Defined in: client/src/resources/recipients/recipients.types.ts:50


phone? ​

optional phone?: string | null

Defined in: client/src/resources/recipients/recipients.types.ts:46

Phone number.


status? ​

optional status?: string

Defined in: client/src/resources/recipients/recipients.types.ts:49


updatedAt? ​

optional updatedAt?: string

Defined in: client/src/resources/recipients/recipients.types.ts:52