Rule.io SDK

---

Rule.io SDK / client/src / CampaignRecipientSegment

Interface: CampaignRecipientSegment

Defined in: client/src/resources/campaigns/campaigns.types.ts:81

A segment used as a campaign recipient filter.

Set negative: true to exclude subscribers in this segment.

Properties

id

id: number

Defined in: client/src/resources/campaigns/campaigns.types.ts:83

Segment ID.

---

name?

optional name?: string

Defined in: client/src/resources/campaigns/campaigns.types.ts:85

Segment name (informational — not sent to the API on create/update).

---

negative

negative: boolean

Defined in: client/src/resources/campaigns/campaigns.types.ts:90

Whether to exclude (true) or include (false) subscribers in this segment.