Navigate...
Cancel Distribution
sdk.distributions.cancel(id)
Cancel a distribution. Works from DRAFT, PREPARED, or IN_PROGRESS status. Distributions in COMPLETED, PARTIALLY_COMPLETED, or FAILED status cannot be cancelled. Note that cancelling an IN_PROGRESS distribution does not reverse already-confirmed on-chain transactions.
Cancelling an IN_PROGRESS distribution stops further batch submissions but does not reverse transactions already confirmed on-chain. Check getTransactions() to see which batches were already confirmed.
Check confirmed transactions
API key required to run methods
API Key *
Base URL
id
string
required
Distribution ID to cancel
Distribution ID
Returns
Distribution
Distribution with status updated to CANCELLED
id
string
Distribution identifier
name
string
Distribution name
status
string
CANCELLED
chainId
number
Target blockchain chain ID
tokenAddress
string
Token contract address
tokenSymbol
string
Token symbol
totalRecipients
number | null
Number of recipients
totalAmount
string | null
Total token amount
account
string | null
Sender wallet address
createdAt
string
ISO 8601 creation timestamp
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
Cannot cancel completed distribution
See Also
get()
Check distribution status before cancelling
distribute()
Create a new distribution to replace the cancelled one
Generated Code