Skip to content

Commit de7d08b

Browse files
committed
Improve documentation
1 parent d0b8143 commit de7d08b

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

README.rst

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -50,17 +50,8 @@ If we do this, operations are stored up in the client, to be run later. For exam
5050

5151
.. code:: python
5252
53-
# add John Doe with email john.doe@example.com to list matching id '123456'
54-
client.lists.members.create(
55-
'123456', {
56-
'email_address': 'john.doe@example.com',
57-
'status': 'subscribed',
58-
'merge_fields': {
59-
'FNAME': 'John',
60-
'LNAME': 'Doe',
61-
},
62-
},
63-
)
53+
# Fetch all MailChimp lists
54+
client.lists.get_all_lists()
6455
6556
All new operations will be added to the batch. When we’re ready, we can run all the operations in the batch:
6657

@@ -72,12 +63,19 @@ We can check the batch’s status using:
7263

7364
.. code:: python
7465
75-
batch.status()
66+
batch.status(refresh=True)
67+
68+
Once it has finished, we can get the response with:
69+
70+
.. code:: python
71+
72+
response = batch.response()
73+
response.body
7674
7775
API Structure and Endpoints
7876
---------------------------
7977

80-
The API structure and endpoints match that of `mailchimp3 <https://pypi.org/project/mailchimp3/>`__. You should refer to their documentation for usage.
78+
The API structure and endpoints match that of `mailchimp-marketing <https://mailchimp.com/developer/marketing/api/>`__. You should refer to their documentation for usage.
8179

8280
Support
8381
-------

0 commit comments

Comments
 (0)