Bulk distribute packages

Asynchronously distribute multiple draft document distribution packages in bulk.
Each package is identified by its ID and must belong to the given firm and be in draft status.

The distribution settings provided in this request — allowDownload, attachDocumentsToEmail, notifyEmail, suppressNewBadge, and emailTemplateId — are applied uniformly to every package in the batch, overriding any per-package settings configured when the package was created or updated. They are the final settings applied at the time of distribution.

This endpoint initiates a background job to process your request, allowing you to distribute up to 100 packages in a single operation. Once complete, the job provides a detailed report on the outcome of each package in CSV format.

All-or-nothing validation: every package in the request must be eligible to distribute. If any package is invalid (not found in the firm, not in draft status, missing documents, document types, or a configured recipient target) or if emailTemplateId does not reference a documentDistribution template for the firm, the entire request is rejected and no packages are distributed.

When notifyEmail is true, recipients receive a single aggregated email per recipient covering all of their packages in the batch (rather than one email per package). When notifyEmail is false, attachDocumentsToEmail and emailTemplateId are ignored.

By default, packages are distributed as the service account. Provide shareBy (the ID of a firm admin) to distribute as that admin instead; the packages and notifications are then attributed to them. Both the service account and the shareBy admin must have an admin role in the firm.

This process is asynchronous; you can find a complete guide to the workflow in our Asynchronous Bulk API documentation.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of the Firm object

Body Params

Parameters for bulk-distributing draft packages. These settings override any per-package settings configured at create/update time.

packageIds
array of objects
required

IDs of the draft packages to distribute. All must belong to the firm and be in draft status.

packageIds*
boolean

Whether recipients can download documents (default: true)

boolean

Whether to attach documents to email notifications (default: false)

boolean

Whether to send email notifications to recipients (default: true)

boolean

Whether to suppress the "New" badge for investors when distributing (default: false)

string

ID of the documentDistribution email template to use for the notification. If not provided, the firm's default document distribution template is used.

string

ID of firm admin to share as (default: service account)

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json