Navigate...
Create Distribution List
sdk.lists.createDistributionList(req)
Create a new recipient list with all recipients in a single call. Returns the list object along with import statistics (added count, errors). This is the fastest way to create a ready-to-use list for distribution.
API key required to run methods
API Key *
Base URL
request.name
string
required
List name
Name
request.notes
string
optional
Optional notes
Notes (optional)
request.recipients
DistributionRecipientDto[]
required
Array of { address, amount, label?, tags? } — all recipients for the list
address,amount (one per line)
Returns
DistributionListCreateResult
Created list with import statistics
list
RecipientList
Created list — list.id is the listId for createDraft()
added
number
Number of recipients successfully added
errors
string[]
Validation error messages for failed rows
Errors
Validation error
The request is not authorized
You do not have permission to access this resource
See Also
createDraft()
Create a distribution using this list
importCsvDistribution()
Create a list from CSV data instead of JSON
Generated Code