Navigate...
Replace Recipients
sdk.distributions.replaceRecipients(id, req)
Replace all recipients on a DRAFT distribution. This is a full replacement — all existing recipients are removed and replaced with the new list. Use this to update the recipient list after creating a draft, or to correct recipients before preparing.
This is a full replacement, not an append. All existing recipients are removed and replaced with the new array.
API key required to run methods
API Key *
Base URL
id
string
required
Distribution ID (must be in DRAFT status)
Distribution ID
request.recipients
RecipientDto[]
required
New recipients array [{ address, amount, label?, tags? }] — replaces all existing
Recipients (JSON)
JSON array of { address, amount, label?, tags? }
Returns
Distribution
Updated distribution with new recipient count and total amount
id
string
Distribution identifier
status
string
DRAFT
totalRecipients
number | null
Updated recipient count
totalAmount
string | null
Updated total amount
updatedAt
string
ISO 8601 last update timestamp
Errors
Invalid distribution id
The request is not authorized
You do not have permission to access this resource
Distribution not found
Not in DRAFT status
See Also
createDraft()
Create the draft distribution first
prepare()
Prepare calldata after finalizing recipients
Generated Code