Rule.io SDK

---

Rule.io SDK / rcml/src / createPlaceholderNode

Function: createPlaceholderNode()

createPlaceholderNode(fieldName, fieldId, options?): PlaceholderNode

Defined in: rcml/src/email/create-rcml-element.ts:1237

Create a placeholder node — a merge-field token that the Rule.io renderer replaces at send time with the subscriber-specific value.

Parameters

fieldName

string

Human-readable display name (e.g. Subscriber.FirstName). Shown in the editor and used as the rendered-time label fallback.

fieldId

number

Numeric custom-field id from Rule.io.

options?

Optional overrides:

• type — placeholder category (CustomField / Subscriber / User / RemoteContent / Date; defaults to CustomField).
• maxLength — render-time character cap (defaults to null, i.e. unlimited).
• original — source-token override (defaults to [<type>:<fieldId>]).

maxLength?

string | null

original?

string

type?

"CustomField" | "Subscriber" | "User" | "RemoteContent" | "Date"

Returns

PlaceholderNode

A typed PlaceholderNode.

Example

createPlaceholderNode('Subscriber.FirstName', 169233)
createPlaceholderNode('Order.Total', 42, { maxLength: '16' })