Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / client/src / CreateDynamicSetPayload

Interface: CreateDynamicSetPayload

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

Payload for DynamicSetsClient.create.

At minimum, provide messageId to attach the dynamic set to a message. Provide templateId to immediately link a template. Omit trigger to create a "Default" dynamic set (the fallback for all subscribers).

Example ​

typescript
const ds = await client.dynamicSets.create({
  messageId,
  templateId,
});

Properties ​

active? ​

optional active?: boolean

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

Whether this dynamic set should be active immediately. Defaults to true.

messageId ​

messageId: number

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

ID of the message this dynamic set belongs to. Required.

name? ​

optional name?: string

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

Name for the dynamic set. Defaults to the trigger name or 'Default'.

preHeader? ​

optional preHeader?: string | null

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

Preheader override.

sender? ​

optional sender?: DynamicSetSender

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

Sender override.

subject? ​

optional subject?: string | null

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

Subject override.

templateId? ​

optional templateId?: number | null

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

ID of the template to attach.

Can be set later via DynamicSetsClient.update.

trigger? ​

optional trigger?: DynamicSetTrigger | null

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

Trigger for this dynamic set.

Omit to create a "Default" dynamic set.

utmCampaign? ​

optional utmCampaign?: string | null

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

UTM campaign override.

utmTerm? ​

optional utmTerm?: string | null

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

UTM term override.