Adding subscribers to a list using Mailchimp s API v3

Question

I m trying to add users to a list I ve created in Mailchimp but I can t find any code examples anywhere  I ve tried figuring out how to use the API but I m very much a  Look at an example and learn  kind of person   I ve tried using version 2 of the API but nothing seems to be working despite working from examples on the net and Mailchimp says the following about earlier versions of their API on their website      Versions 2 0 and earlier are deprecated  Only minimal support   bug fixes  security patches   will be available for those versions    UPDATE 1  I did some further research based on TooMuchPete s answer with regards to the link on Managing Subscribers and altered some code I found here  but it won t work because the function http build query   doesn t deal with nested arrays  I m not sure how to deal with the  merge fields  portion of adding a subscriber  My current code is below    postdata   http build query                      array                           apikey           gt   apikey                           email address    gt   email                           status           gt   subscribed                            merge fields     gt  array                               FNAME    gt   name                                                                                      opts   array  http    gt                      array                           method     gt   POST                            header     gt   Content-type  application x-www-form-urlencoded                            content    gt   postdata                                                            context    stream context create  opts                     result   file get contents  https   us2 api mailchimp com 3 0 lists  lt list id gt  members    false   context                    var dump  result                   die  Mailchimp executed      UPDATE 2  I ve now resorted to using curl and I ve managed to get something almost working  The data sends through to Mailchimp but I m receiving the error  Your request did not include an API key   I m guessing I need to authenticate as mentioned here  I ve tried adding it to the http header which hasn t worked  See my code below    apikey     lt api key gt                     auth   base64 encode   user    apikey                      data   array                       apikey           gt   apikey                       email address    gt   email                       status           gt   subscribed                        merge fields     gt  array                           FNAME    gt   name                                                           json data   json encode  data                     ch   curl init                    curl setopt  ch  CURLOPT URL   https   us2 api mailchimp com 3 0 lists  lt list id gt  members                     curl setopt  ch  CURLOPT HTTPHEADER  array  Content-Type  application json r n                                                             Authorization  Basic    auth                    curl setopt  ch  CURLOPT USERAGENT   PHP-MCAPI 2 0                    curl setopt  ch  CURLOPT RETURNTRANSFER  true                   curl setopt  ch  CURLOPT TIMEOUT  10                   curl setopt  ch  CURLOPT POST  true                   curl setopt  ch  CURLOPT SSL VERIFYPEER  false                   curl setopt  ch  CURLOPT POSTFIELDS   json data                                                                                                                                       result   curl exec  ch                    var dump  result                   die  Mailchimp executed

User · Answer

I got it working  I was adding the authentication to the header incorrectly    apikey     lt api key gt                 auth   base64 encode   user    apikey                  data   array                   apikey           gt   apikey                   email address    gt   email                   status           gt   subscribed                    merge fields     gt  array                       FNAME    gt   name                                               json data   json encode  data                 ch   curl init                curl setopt  ch  CURLOPT URL   https   us2 api mailchimp com 3 0 lists  lt list id gt  members                 curl setopt  ch  CURLOPT HTTPHEADER  array  Content-Type  application json                                                            Authorization  Basic    auth                curl setopt  ch  CURLOPT USERAGENT   PHP-MCAPI 2 0                curl setopt  ch  CURLOPT RETURNTRANSFER  true               curl setopt  ch  CURLOPT TIMEOUT  10               curl setopt  ch  CURLOPT POST  true               curl setopt  ch  CURLOPT SSL VERIFYPEER  false               curl setopt  ch  CURLOPT POSTFIELDS   json data                                                                                                                                   result   curl exec  ch                var dump  result               die  Mailchimp executed

User · Answer

If you Want to run Batch Subscribe on a List using Mailchimp API   Then you can use the below function                  Mailchimp API- List Batch Subscribe added function                param array   data   Passed you data as an array format          param string  apikey your mailchimp api key                 return mixed             function batchSubscribe array  data   apikey                 auth            base64 encode  user      apikey            json postData   json encode  data            ch              curl init             dataCenter      substr  apikey  strpos  apikey   -     1            curlopt url      https        dataCenter     api mailchimp com 3 0 batches            curl setopt  ch  CURLOPT URL   curlopt url           curl setopt  ch  CURLOPT HTTPHEADER  array  Content-Type  application json                Authorization  Basic      auth            curl setopt  ch  CURLOPT USERAGENT   PHP-MCAPI 3 0            curl setopt  ch  CURLOPT RETURNTRANSFER  true           curl setopt  ch  CURLOPT TIMEOUT  10           curl setopt  ch  CURLOPT POST  true           curl setopt  ch  CURLOPT SSL VERIFYPEER  false           curl setopt  ch  CURLOPT POSTFIELDS   json postData            result   curl exec  ch           return  result          Function Use And Data format for Batch Operations    lt  php  apikey     Your MailChimp Api Key    list id    Your list ID    servername    localhost    username      Youre DB username    password      Your DB password    dbname        Your DB Name      Create connection  conn   new mysqli  servername   username   password   dbname      Check connection if   conn- gt connect error        die  Connection failed       conn- gt connect error      sql          SELECT   FROM emails     your SQL Query goes here  result       conn- gt query  sql    finalData       if   result- gt num rows  gt  0           output data of each row     while   row    result- gt fetch assoc               individulData   array               apikey           gt   apikey               email address    gt   row  email                 status           gt   subscribed                merge fields     gt  array                   FNAME    gt   eastwest                    LNAME    gt   rehab                                     json individulData          json encode  individulData            finalData  operations                   array                   method    gt   POST                    path      gt    lists  list id members                     body      gt   json individulData                         api response   batchSubscribe  finalData   apikey   print r  api response    conn- gt close      Also  You can found this code in my Github gist  GithubGist Link  Reference Documentation  Official

User · Answer

If it helps anyone  here is what I got working in Python using the Python Requests library instead of CURL   As explained by  staypuftman above  you will need your API Key and List ID from MailChimp and make sure your API Key suffix and URL prefix  i e  us5  match   Python                                                                                               To add a single contact to MailChimp  using MailChimp v3 0 API   requires        MailChimp API Key       MailChimp List Id for specific list       MailChimp API URL for adding a single new contact     Note  the API URL has a 3 4 character location subdomain at the front of the URL string     It can vary depending on where you are in the world  To determine yours  check the last    3 4 characters of your API key  The API URL location subdomain must match API Key    suffix e g  us5  us13  us19 etc  but in this example  us5     suggest you put the following 3 values in  settings  or  secrets  file                                                                                            MAILCHIMP API KEY    your-api-key-here-us5  MAILCHIMP LIST ID    your-list-id-here  MAILCHIMP ADD CONTACT TO LIST URL    https   us5 api mailchimp com 3 0 lists     MAILCHIMP LIST ID     members          Create new contact data and convert into JSON as this is what MailChimp expects in the API       I ve hardcoded some test data but use what you get from your form as appropriate     new contact data dict              email address    test testing com                   email address  is a mandatory field          status    subscribed                                status  is a mandatory field          merge fields                                        merge fields  are optional               FNAME    John                                  LNAME    Smith                      new contact data json   json dumps new contact data dict         Create the new contact using MailChimp API using Python  Requests  library     req   requests post          MAILCHIMP ADD CONTACT TO LIST URL          data new contact data json          auth   user   MAILCHIMP API KEY           headers   content-type    application json                debug info if required -  text and  json also list the  merge fields  names for use in contact JSON above       print req status code       print req text       print req json        if req status code    200            success - do anything you need to do     else            fail - do anything you need to do - but here is a useful debug message         mailchimp fail    MailChimp call failed calling this URL   0  n                              Returned this HTTP status code   1  n                              Returned this response text   2                               format req url  str req status code   req text

User · Answer

These are good answers but detached from a full answer as to how you would get a form to send data and handle that response  This will demonstrate how to add a member to a list with v3 0 of the API from an HTML page via jquery  ajax      In Mailchimp    Acquire your API Key and List ID Make sure you setup your list and what custom fields you want to use with it  In this case  I ve set up zipcode as a custom field in the list BEFORE I did the API call  Check out the API docs on adding members to lists  We are using the create method which requires the use of HTTP POST requests  There are other options in here that require PUT if you want to be able to modify delete subs    HTML    lt form id  pfb-signup-submission  method  post  gt     lt div class  sign-up-group  gt       lt input type  text  name  pfb-signup  id  pfb-signup-box-fname  class  pfb-signup-box  placeholder  First Name  gt       lt input type  text  name  pfb-signup  id  pfb-signup-box-lname  class  pfb-signup-box  placeholder  Last Name  gt       lt input type  email  name  pfb-signup  id  pfb-signup-box-email  class  pfb-signup-box  placeholder  youremail example com  gt       lt input type  text  name  pfb-signup  id  pfb-signup-box-zip  class  pfb-signup-box  placeholder  Zip Code  gt     lt  div gt     lt input type  submit  class  submit-button  value  Sign-up  id  pfb-signup-button  gt  lt  a gt     lt div id  pfb-signup-result  gt  lt  div gt   lt  form gt    Key things    Give your  lt form gt  a unique ID and don t forget the method  post  attribute so the form works   Note the last line  signup-result is where you will deposit the feedback from the PHP script    PHP    lt  php           Add a  member  to a  list  via mailchimp API v3 x        http   developer mailchimp com documentation mailchimp reference lists members  create-post lists list id members                                 BACKGROUND      Typical use case is that this code would get run by an  ajax   jQuery call or possibly a form action      The live data you need will get transferred via the global   POST variable      That data must be put into an array with keys that match the mailchimp endpoints  check the above link for those      You also need to include your API key and list ID for this to work       You ll just have to go get those and type them in here  see README md                                   Set API Key and list ID to add a subscriber    api key    your-api-key-here      list id    your-list-id-here                               DESTINATION URL      Note  your API URL has a location subdomain at the front of the URL string      It can vary depending on where you are in the world      To determine yours  check the last 3 digits of your API key                                url    https   us5 api mailchimp com 3 0 lists      list id     members                                DATA SETUP      Encode data into a format that the add subscriber mailchimp end point is looking for      Must include  email address  and  status       Statuses  pending   they get an email  subscribed   they don t get an email      Custom fields go into the  merge fields  as another array      More here  http   developer mailchimp com documentation mailchimp reference lists members  create-post lists list id members                                pfb data   array       email address    gt    POST  emailname         status           gt   pending        merge fields     gt  array         FNAME          gt    POST  firstname           LNAME          gt    POST  lastname           ZIPCODE        gt    POST  zipcode                     Encode the data    encoded pfb data   json encode  pfb data         Setup cURL sequence    ch   curl init                                cURL OPTIONS      The tricky one here is the  USERPWD - this is how you transfer the API key over       RETURNTRANSFER allows us to get the response into a variable which is nice      This example just POSTs  we don t edit modify - just a simple add to a list       POSTFIELDS does the heavy lifting       SSL VERIFYPEER should probably be set but I didn t do it here                               curl setopt  ch  CURLOPT URL   url     curl setopt  ch  CURLOPT USERPWD   user      api key     curl setopt  ch  CURLOPT HTTPHEADER  array  Content-Type  application json       curl setopt  ch  CURLOPT RETURNTRANSFER  true     curl setopt  ch  CURLOPT TIMEOUT  10     curl setopt  ch  CURLOPT POST  1     curl setopt  ch  CURLOPT POSTFIELDS   encoded pfb data     curl setopt  ch  CURLOPT SSL VERIFYPEER  false       results   curl exec  ch      store response    response   curl getinfo  ch  CURLINFO HTTP CODE      get HTTP CODE    errors   curl error  ch      store errors    curl close  ch         Returns info back to jQuery  ajax or just outputs onto the page     results   array       results    gt   result info       response    gt   response       errors    gt   errors            Sends data back to the page OR the ajax   in your JS   echo json encode  results     gt    Key things    CURLOPT USERPWD handles the API key and Mailchimp doesn t really show you how to do this   CURLOPT RETURNTRANSFER gives us the response in such a way that we can send it back into the HTML page with the  ajax   success handler  Use json encodeon the data you received    JS      Signup form submission     pfb-signup-submission   submit function event      event preventDefault          Get data from form and store it   var pfbSignupFNAME       pfb-signup-box-fname   val      var pfbSignupLNAME       pfb-signup-box-lname   val      var pfbSignupEMAIL       pfb-signup-box-email   val      var pfbSignupZIP       pfb-signup-box-zip   val          Create JSON variable of retreived data   var pfbSignupData          firstname   pfbSignupFNAME       lastname   pfbSignupLNAME       email   pfbSignupEMAIL       zipcode   pfbSignupZIP            Send data to PHP script via  ajax   of jQuery     ajax       type   POST       dataType   json       url   mailchimp-signup php       data  pfbSignupData      success  function  results              pfb-signup-box-fname   hide              pfb-signup-box-lname   hide              pfb-signup-box-email   hide              pfb-signup-box-zip   hide              pfb-signup-result   text  Thanks for adding yourself to the email list  We will be in touch           console log results              error  function  results              pfb-signup-result   html   lt p gt Sorry but we were unable to add you into the email list  lt  p gt           console log results                     Key things    JSON data is VERY touchy on transfer  Here  I am putting it into an array and it looks easy  If you are having problems  it is likely because of how your JSON data is structured  Check this out  The keys for your JSON data will become what you reference in the PHP  POST global variable  In this case it will be  POST  email     POST  firstname    etc  But you could name them whatever you want - just remember what you name the keys of the data part of your JSON transfer is how you access them in PHP  This obviously requires jQuery

User · Answer

Based on the List Members Instance docs  the easiest way is to use a PUT request which according to the docs either  adds a new list member or updates the member if the email already exists on the list    Furthermore apikey is definitely not part of the json schema and there s no point in including it in your json request   Also  as noted in  TooMuchPete s comment  you can use CURLOPT USERPWD for basic http auth as illustrated in below   I m using the following function to add and update list members   You may need to include a slightly different set of merge fields depending on your list parameters    data          email        gt   johndoe example com        status       gt   subscribed        firstname    gt   john        lastname     gt   doe      syncMailchimp  data    function syncMailchimp  data         apiKey    your api key        listId    your list id         memberId   md5 strtolower  data  email           dataCenter   substr  apiKey strpos  apiKey  -   1        url    https        dataCenter     api mailchimp com 3 0 lists      listId     members      memberId        json   json encode            email address    gt   data  email             status           gt   data  status        subscribed   unsubscribed   cleaned   pending           merge fields     gt                 FNAME        gt   data  firstname                 LNAME        gt   data  lastname                           ch   curl init  url        curl setopt  ch  CURLOPT USERPWD   user      apiKey       curl setopt  ch  CURLOPT HTTPHEADER    Content-Type  application json         curl setopt  ch  CURLOPT RETURNTRANSFER  true       curl setopt  ch  CURLOPT TIMEOUT  10       curl setopt  ch  CURLOPT CUSTOMREQUEST   PUT        curl setopt  ch  CURLOPT SSL VERIFYPEER  false       curl setopt  ch  CURLOPT POSTFIELDS   json                                                                                                                          result   curl exec  ch        httpCode   curl getinfo  ch  CURLINFO HTTP CODE       curl close  ch        return  httpCode

User · Answer

BATCH LOAD - OK  so after having my previous reply deleted for just using links I have updated with the code I managed to get working  Appreciate anyone to simplify   correct   refine   put in function etc as I m still learning this stuff  but I got batch member list add working      apikey    whatever-us99                                list id    12ab34dc56     email1    jack email com    fname1    Jack    lname1    Black     email2    jill email com    fname2    Jill    lname2    Hill     auth   base64 encode   user    apikey      data1   array       apikey           gt   apikey       email address    gt   email1       status           gt   subscribed        merge fields     gt  array                               FNAME    gt   fname1               LNAME    gt   lname1             data2   array       apikey           gt   apikey       email address    gt   email2       status           gt   subscribed                        merge fields     gt  array                               FNAME    gt   fname2               LNAME    gt   lname2             json data1   json encode  data1    json data2   json encode  data2     array   array       operations    gt  array          array               method    gt   POST                path    gt    lists  list id members                 body    gt   json data1                    array               method    gt   POST                path    gt    lists  list id members                 body    gt   json data2                      json post   json encode  array     ch   curl init      curlopt url    https   us99 api mailchimp com 3 0 batches   curl setopt  ch  CURLOPT URL   curlopt url    curl setopt  ch  CURLOPT HTTPHEADER  array  Content-Type  application json    Authorization  Basic    auth    curl setopt  ch  CURLOPT USERAGENT   PHP-MCAPI 3 0    curl setopt  ch  CURLOPT RETURNTRANSFER  true   curl setopt  ch  CURLOPT TIMEOUT  10   curl setopt  ch  CURLOPT POST  true   curl setopt  ch  CURLOPT SSL VERIFYPEER  false   curl setopt  ch  CURLOPT POSTFIELDS   json post    print r  json post     n     result   curl exec  ch    var dump  result     n    print r   result     n

[php] Adding subscribers to a list using Mailchimp's API v3

Examples related to php

Examples related to json

Examples related to curl

Examples related to mailchimp

Examples related to mailchimp-api-v3.0