Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / client/src / DynamicSet

Interface: DynamicSet

Defined in: client/src/resources/dynamic-sets/dynamic-sets.types.ts:67

A dynamic set entity as returned by the API.

Dynamic sets are returned with camelCase fields; the SDK normalises from the wire's snake_case format.

Properties ​

active ​

active: boolean

Defined in: client/src/resources/dynamic-sets/dynamic-sets.types.ts:114

Whether this dynamic set is active.

Only one active dynamic set per trigger is allowed. Setting active: true on a dynamic set with a duplicate trigger deactivates the existing one.

createdAt ​

createdAt: string

Defined in: client/src/resources/dynamic-sets/dynamic-sets.types.ts:118

ISO 8601 timestamp of when the dynamic set was created.

id ​

id: number

Defined in: client/src/resources/dynamic-sets/dynamic-sets.types.ts:69

Dynamic set ID.

name ​

name: string

Defined in: client/src/resources/dynamic-sets/dynamic-sets.types.ts:76

Internal name for the dynamic set.

Defaults to the trigger name (or 'Default' for trigger-less sets) unless explicitly provided at creation time.

position ​

position: number

Defined in: client/src/resources/dynamic-sets/dynamic-sets.types.ts:116

Position (ordering) within the message's dynamic set list. Minimum 1.

preHeader? ​

optional preHeader?: string | null

Defined in: client/src/resources/dynamic-sets/dynamic-sets.types.ts:94

Preheader override for this dynamic set.

When present, overrides the preheader from the parent message.

sender? ​

optional sender?: DynamicSetSender

Defined in: client/src/resources/dynamic-sets/dynamic-sets.types.ts:100

Sender override for this dynamic set's audience.

subject? ​

optional subject?: string | null

Defined in: client/src/resources/dynamic-sets/dynamic-sets.types.ts:88

Email subject override for this dynamic set.

When present, overrides the subject from the parent message.

templateId? ​

optional templateId?: number | null

Defined in: client/src/resources/dynamic-sets/dynamic-sets.types.ts:82

ID of the template attached to this dynamic set.

null when no template has been attached yet.

trigger? ​

optional trigger?: DynamicSetTrigger | null

Defined in: client/src/resources/dynamic-sets/dynamic-sets.types.ts:107

Trigger that activates this dynamic set.

null for the "Default" dynamic set, which is the fallback for subscribers not matched by any trigger-specific variant.

updatedAt ​

updatedAt: string

Defined in: client/src/resources/dynamic-sets/dynamic-sets.types.ts:120

ISO 8601 timestamp of when the dynamic set was last updated.

utmCampaign? ​

optional utmCampaign?: string | null

Defined in: client/src/resources/dynamic-sets/dynamic-sets.types.ts:96

UTM campaign parameter override.

utmTerm? ​

optional utmTerm?: string | null

Defined in: client/src/resources/dynamic-sets/dynamic-sets.types.ts:98

UTM term parameter override.