Rule.io SDK

---

Rule.io SDK / client/src / BulkCreateSubscribersResult

Interface: BulkCreateSubscribersResult

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

Return value of SubscribersClient.bulkCreateSubscribers.

The v2 endpoint processes large batches asynchronously, so the synchronous response is an acknowledgement rather than the list of created subscribers. Numeric counters are populated when the API includes them in the response.

Properties

message?

optional message?: string

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

Optional success message echoed by the API.

---

subscribersCreated?

optional subscribersCreated?: number

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

Number of subscribers created when reported by the API.

---

subscribersSuppressed?

optional subscribersSuppressed?: number

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

Number of suppressed addresses skipped, when reported.

---

subscribersUpdated?

optional subscribersUpdated?: number

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

Number of subscribers updated when reported by the API.

---

success

success: true

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