Rule.io SDK

---

Rule.io SDK / client/src / Subscriber

Interface: Subscriber

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

Unified subscriber entity returned by all lookup and create methods.

The phone field is canonical — the raw Rule.io API uses phone in v3 responses and phone_number in v2 responses. The SDK always normalises to phone so consumers never need to track which API version was called.

Properties

createdAt?

optional createdAt?: string

Defined in: client/src/resources/subscribers/subscribers.types.ts:39

---

customIdentifier

customIdentifier: string | null

Defined in: client/src/resources/subscribers/subscribers.types.ts:32

---

email

email: string | null

Defined in: client/src/resources/subscribers/subscribers.types.ts:29

---

id

id: number

Defined in: client/src/resources/subscribers/subscribers.types.ts:28

---

language?

optional language?: string

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

---

optedIn?

optional optedIn?: boolean

Defined in: client/src/resources/subscribers/subscribers.types.ts:35

---

phone

phone: string | null

Defined in: client/src/resources/subscribers/subscribers.types.ts:31

Canonical phone field — normalised from phone (v3) or phone_number (v2).

---

status?

optional status?: string

Defined in: client/src/resources/subscribers/subscribers.types.ts:33

---

suppressed?

optional suppressed?: boolean

Defined in: client/src/resources/subscribers/subscribers.types.ts:36

---

syncAtSegments?

optional syncAtSegments?: SubscriberSegment[]

Defined in: client/src/resources/subscribers/subscribers.types.ts:38

---

tags?

optional tags?: SubscriberTag[]

Defined in: client/src/resources/subscribers/subscribers.types.ts:37

---

updatedAt?

optional updatedAt?: string

Defined in: client/src/resources/subscribers/subscribers.types.ts:40