Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / client/src / UpdateDynamicSetPayload

Interface: UpdateDynamicSetPayload

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

Payload for DynamicSetsClient.update.

All fields are optional — only the fields you include are changed.

Example ​

typescript
// Swap in a different template
await client.dynamicSets.update(dynamicSetId, { templateId: newTemplateId });

// Change the trigger
await client.dynamicSets.update(dynamicSetId, {
  trigger: { type: 'TAG', id: tagId },
});

Properties ​

active? ​

optional active?: boolean

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

Change the active state.

name? ​

optional name?: string

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

New name.

preHeader? ​

optional preHeader?: string | null

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

New preheader override.

sender? ​

optional sender?: DynamicSetSender

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

New sender override.

subject? ​

optional subject?: string | null

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

New subject override.

templateId? ​

optional templateId?: number | null

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

New template to attach.

trigger? ​

optional trigger?: DynamicSetTrigger | null

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

New trigger. Pass null to convert to a "Default" dynamic set.

utmCampaign? ​

optional utmCampaign?: string | null

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

New UTM campaign override.

utmTerm? ​

optional utmTerm?: string | null

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

New UTM term override.