Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / client/src / BulkCreateSubscribersPayload

Interface: BulkCreateSubscribersPayload

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

Payload for SubscribersClient.bulkCreateSubscribers.

Wraps the v2 POST /subscribers "create multiple" endpoint. Top-level fields apply to every subscriber in the batch; per-entry fields are set on each BulkCreateSubscriberEntry.

Properties ​

automation? ​

optional automation?: BulkCreateAutomationMode

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

Automation handling for matched subscribers. See BulkCreateAutomationMode.

language? ​

optional language?: string

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

Default language applied to subscribers that omit language.

requireOptIn? ​

optional requireOptIn?: boolean

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

If true, run the opt-in flow rather than creating subscribers directly.

subscribers ​

subscribers: BulkCreateSubscriberEntry[]

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

Up to 1000 entries per call. The API rejects larger batches with 413.

syncSubscribers? ​

optional syncSubscribers?: boolean

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

Controls automation firing for the whole batch. true fires automations for every subscriber (capped server-side at 100). false disables automations for the batch. If omitted, automations fire only when the batch has fewer than 20 subscribers.

tags? ​

optional tags?: (string | number)[]

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

Tags applied to every subscriber in the batch. Numeric IDs and string names may be mixed. Tags consisting only of digits are interpreted as IDs.

updateOnDuplicate? ​

optional updateOnDuplicate?: boolean

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

If true, existing subscribers (matched by email or phone) are updated rather than rejected with 409. Defaults to false.