Navigate...
Add Recipient
sdk.lists.addRecipient(listId, req)
Add a single recipient to a list. Returns both the created recipient and the list item entry. EVM addresses support ENS names (e.g. vitalik.eth) which are resolved automatically.
API key required to run methods
API Key *
Base URL
listId
string
required
List ID to add the recipient to
List ID
request.address
string
required
Wallet address or ENS name (ENS resolved for EVM)
Address
request.addressType
AddressType
required
Blockchain address format
Address Type
request.amount
string
required
Token amount in human-readable units (e.g. "10.5"). Must be > 0.
Amount
request.label
string
optional
Human-readable label for the recipient
Label (optional)
request.tags
string[]
optional
Tags for categorization
Tags (optional, comma-separated)
request.metadata
Record<string, unknown>
optional
Arbitrary metadata object
Metadata (optional, JSON)
Returns
AddRecipientResult
{ recipient, listItem } — the created recipient and its list entry
recipient.id
string
Recipient identifier
recipient.address
string
Wallet address (ENS resolved)
recipient.addressType
string
EVM (currently supported) | SOLANA | TRON | MOVE_EVM | TON (coming soon)
recipient.label
string | null
Human-readable label
recipient.metadata
object | null
Arbitrary metadata
listItem.id
string
List item identifier
listItem.amount
string | null
Token amount
listItem.tags
string[]
Tags for this entry
Errors
Validation error
Invalid list id
The request is not authorized
You do not have permission to access this resource
List not found
See Also
addRecipientsBulk()
Add multiple recipients at once for better performance
getRecipients()
View all recipients after adding
removeListItem()
Remove this item later
Generated Code