Navigate...

K

Bulk Delete Recipients

sdk.lists.bulkDeleteRecipients(listId, req)

Delete multiple list items from a list in a single request. Pass the list item IDs returned by getRecipients() — not recipient IDs. Returns the number of items actually deleted.

API key required to run methods

API Key *

Don't have an API key?Get one at dashboard.multisender.app

Base URL

listId

string

required

List ID

List ID

List item IDs (one per line) *

Returns

BulkDeleteRecipientsResult

Deletion summary

deletedCount

number

Number of list items actually deleted

Errors

400

Validation error

400

Invalid list id

401

The request is not authorized

403

You do not have permission to access this resource

404

List not found

See Also

getRecipients()

Find the list item IDs to delete

Generated Code