Recipient Lists

This library provides easy access to the Recipient Lists Resource.

Note: All methods return promises and accept an optional last argument callback. Read about how we handle callbacks and promises.

Methods

list()
List a summary of all recipient lists.
get(id[, options])
Retrieve details about a specified recipient list by its id
- options.show_recipients - specifies whether to retrieve the recipients | Default: false
create(recipientList)
Create a new recipient list
- recipientList - an object of recipient list required
- recipientList.num_rcpt_errors - limit the number of recipient errors returned | Default: all errors returned
update(id, recipientList)
Update an existing recipient list
- recipientList - an object of recipient list required
- recipientList.num_rcpt_errors - limit the number of recipient errors returned | Default: all errors returned
delete(id)
Delete an existing recipient list
- id - the id of the recipient list you want to delete required

Visit our examples section to see all of our recipient list resource examples.