Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / client/src / RenderTemplateParams

Interface: RenderTemplateParams

Defined in: client/src/resources/templates/templates.types.ts:239

Parameters for TemplatesClient.render.

Example ​

typescript
// Render without subscriber context (merge tags shown as placeholders)
const html = await client.templates.render(templateId);

// Render with a subscriber's data substituted into merge tags
const personalized = await client.templates.render(templateId, { subscriberId: 42 });

Properties ​

subscriberId? ​

optional subscriberId?: number

Defined in: client/src/resources/templates/templates.types.ts:247

Subscriber ID to use for merge tag substitution.

When provided, the rendered output replaces merge tag placeholders (e.g. \{\{Booking.FirstName\}\}) with the subscriber's actual field values. Omit to render with placeholder text instead.