Recipient Lists

Let’s use the underlying recipient_lists API to create a recipient list:

from sparkpost import SparkPost

sp = SparkPost()

response = sp.recipient_lists.create(
    id='UNIQUE_TEST_ID',
    name='Test Recipient list',
    recipients=[
        {
            'address': {
                'email': 'test1@test.com'
            }
        },
        {
            'address': {
                'email': 'test2@test.com'
            }
        },
        {
            'address': {
                'email': 'test3@test.com'
            }
        }
    ]
)

print(response)
# outputs {u'total_accepted_recipients': 3, u'id': u'UNIQUE_TEST_ID', u'total_rejected_recipients': 0, u'name':'Test Recipient list'}

Retrieve a recipient list

from sparkpost import SparkPost

sp = SparkPost()

sp.recipient_lists.get('my-list-id')

List all recipient lists

from sparkpost import SparkPost

sp = SparkPost()

sp.recipient_lists.list()

Additional documentation

See the SparkPost Recipient Lists API Reference.