Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / client/src / BulkCreateSubscriberField

Interface: BulkCreateSubscriberField

Defined in: client/src/resources/subscribers/subscribers.types.ts:177

One custom-field value attached to a BulkCreateSubscriberEntry.

The key follows Group.Field notation. The value shape depends on type — a string for 'text', 'date', 'datetime', 'time', and 'json'; a string array for 'multiple'.

Properties ​

key ​

key: string

Defined in: client/src/resources/subscribers/subscribers.types.ts:179

Custom field identifier in 'Group.Field' form, e.g. 'Order.Total'.

type? ​

optional type?: "date" | "text" | "multiple" | "json" | "datetime" | "time"

Defined in: client/src/resources/subscribers/subscribers.types.ts:188

Defaults to 'text' server-side when omitted.

value ​

value: string | number | string[]

Defined in: client/src/resources/subscribers/subscribers.types.ts:186

Field value. Types align with type:

  • 'text' / 'date' / 'datetime' / 'time' / 'json' — string.
  • 'multiple' — string array.
  • Numbers are accepted by the API for numeric custom fields.