{"__v":0,"_id":"56d88888b159f10b00304640","category":{"__v":1,"_id":"56d88885b159f10b0030460c","pages":["56d88888b159f10b0030463f","56d88888b159f10b00304640"],"project":"549a321bf876ae0b00f33623","version":"56d88884b159f10b00304609","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-05-20T00:49:34.139Z","from_sync":false,"order":2,"slug":"extensions","title":"Extensions"},"parentDoc":null,"project":"549a321bf876ae0b00f33623","user":"549a320d5b50c21400fae689","version":{"__v":3,"_id":"56d88884b159f10b00304609","project":"549a321bf876ae0b00f33623","createdAt":"2016-03-03T18:55:00.567Z","releaseDate":"2016-03-03T18:55:00.567Z","categories":["56d88885b159f10b0030460a","56d88885b159f10b0030460b","56d88885b159f10b0030460c","56d88885b159f10b0030460d","56d88885b159f10b0030460e","56d88885b159f10b0030460f","56d88885b159f10b00304610","56d88885b159f10b00304611","56d88885b159f10b00304612","56d88885b159f10b00304613","56d88885b159f10b00304614","56d89250b159f10b003046d4","56da13977222d50b0070167c"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.2.1","version":"2.2.1"},"updates":["561fcca3cfc3610d00567322"],"next":{"pages":[],"description":""},"createdAt":"2015-07-17T18:22:22.257Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"The MailChimp extension allows you to add users to lists or groups when they register for a course. You can use the MailChimp extension in addition to the email engagement functionality provided by LifterLMS.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Installation\"\n}\n[/block]\nTo install the MailChimp extension log into the admin panel of your WordPress site. \n\nGo to Plugins. Click \"Add New.\" On the next page click \"Upload Plugin.\" \n\nOn the Add Plugins page click Choose File, navigate to where the MailChimp extension zip file is located on your computer, click on the zip file, then click \"Open.\" Once the file has been chosen, click \"Install Now.\" When the plugin installation is finished, click \"Activate this plugin.\"\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Getting Started\"\n}\n[/block]\nOnce you have installed the plugin you can then enable the MailChimp extension. \n\nFrom the WordPress admin navigate to LifterLMS > Settings and click on the tab Integrations. You will see a section titled MailChimp Settings.\n\nIn the MailChimp Settings section you can activate your MailChimp plugin by entering the activation key in the text box titled “Activation Key.” You should have received an activation key when you purchased the extension.\n\nTo enable users to be added to your lists in MailChimp you will check the box \"Enable MailChimp.\" You will also need to enter your API. See next section for getting your API key.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Getting API Key\"\n}\n[/block]\nTo enable users to be added to your lists in MailChimp you need to enter your API Key.\n\nIf you do not have a MailChimp account you will need to create one at [mailchimp.com](http://mailchimp.com).\n\nLog into your MailChimp account. Click on your MailChimp username in the top right corner and click on “Account.”\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/MqP0d9iRRBK5WWP4FOtr_MailChimp%20Username.png\",\n        \"MailChimp Username.png\",\n        \"1174\",\n        \"424\",\n        \"#ea604b\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nClick on “Extras” and then click on “API Keys.”\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/WhPzqYnRlak8PCR7ZJYQ_API%20Keys.png\",\n        \"API Keys.png\",\n        \"1160\",\n        \"349\",\n        \"#bc7a73\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nClick on the Create a Key button.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/L3Shvdf6TnS5VuGDjAlO_Create%20a%20Key.png\",\n        \"Create a Key.png\",\n        \"1166\",\n        \"387\",\n        \"#a37c78\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nCopy the API key you created in MailChimp and paste it into the in the text box titled “API Key” in LifterLMS. You can test your connection to MailChimp using the Test Connection button. If the connection is successful, you will see a message at the top of the page confirming that the test succeeded.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Add New Users to List\"\n}\n[/block]\nOnce you’ve connected the MailChimp Extension to your MailChimp account, you can choose the list you’d like new users to be added to upon registration.\n\nClick on the Update Lists button and choose the list you’d like new users to be added to upon registration.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/hpf4dgsQRJmtJPua1mEa_Registration%20List.png\",\n        \"Registration List.png\",\n        \"573\",\n        \"138\",\n        \"#0e97b3\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nClick on the Save Changes button.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Add New Students to a List and Group\"\n}\n[/block]\nYou can add new students to a MailChimp list and group when they register for a course. \n\nFrom the WordPress admin navigate to LifterLMS > Courses and choose the course for which you’d like to add students to a list and group. \n\nClick on “MailChimp Settings” in the blue menu. Select the list you’d like new students to be added to when they register for the course from the New Registration List dropdown field. If you’d like you can also select a group to add students to when they register for the course from the New Registration Group dropdown field.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/NymGDATVQaCXDt1UTHDH_List%20and%20Group.png\",\n        \"List and Group.png\",\n        \"697\",\n        \"392\",\n        \"#34adcb\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nClick on the Update button to save your changes.","excerpt":"","slug":"mailchimp-extension","type":"basic","title":"MailChimp API"}
The MailChimp extension allows you to add users to lists or groups when they register for a course. You can use the MailChimp extension in addition to the email engagement functionality provided by LifterLMS. [block:api-header] { "type": "basic", "title": "Installation" } [/block] To install the MailChimp extension log into the admin panel of your WordPress site. Go to Plugins. Click "Add New." On the next page click "Upload Plugin." On the Add Plugins page click Choose File, navigate to where the MailChimp extension zip file is located on your computer, click on the zip file, then click "Open." Once the file has been chosen, click "Install Now." When the plugin installation is finished, click "Activate this plugin." [block:api-header] { "type": "basic", "title": "Getting Started" } [/block] Once you have installed the plugin you can then enable the MailChimp extension. From the WordPress admin navigate to LifterLMS > Settings and click on the tab Integrations. You will see a section titled MailChimp Settings. In the MailChimp Settings section you can activate your MailChimp plugin by entering the activation key in the text box titled “Activation Key.” You should have received an activation key when you purchased the extension. To enable users to be added to your lists in MailChimp you will check the box "Enable MailChimp." You will also need to enter your API. See next section for getting your API key. [block:api-header] { "type": "basic", "title": "Getting API Key" } [/block] To enable users to be added to your lists in MailChimp you need to enter your API Key. If you do not have a MailChimp account you will need to create one at [mailchimp.com](http://mailchimp.com). Log into your MailChimp account. Click on your MailChimp username in the top right corner and click on “Account.” [block:image] { "images": [ { "image": [ "https://files.readme.io/MqP0d9iRRBK5WWP4FOtr_MailChimp%20Username.png", "MailChimp Username.png", "1174", "424", "#ea604b", "" ] } ] } [/block] Click on “Extras” and then click on “API Keys.” [block:image] { "images": [ { "image": [ "https://files.readme.io/WhPzqYnRlak8PCR7ZJYQ_API%20Keys.png", "API Keys.png", "1160", "349", "#bc7a73", "" ] } ] } [/block] Click on the Create a Key button. [block:image] { "images": [ { "image": [ "https://files.readme.io/L3Shvdf6TnS5VuGDjAlO_Create%20a%20Key.png", "Create a Key.png", "1166", "387", "#a37c78", "" ] } ] } [/block] Copy the API key you created in MailChimp and paste it into the in the text box titled “API Key” in LifterLMS. You can test your connection to MailChimp using the Test Connection button. If the connection is successful, you will see a message at the top of the page confirming that the test succeeded. [block:api-header] { "type": "basic", "title": "Add New Users to List" } [/block] Once you’ve connected the MailChimp Extension to your MailChimp account, you can choose the list you’d like new users to be added to upon registration. Click on the Update Lists button and choose the list you’d like new users to be added to upon registration. [block:image] { "images": [ { "image": [ "https://files.readme.io/hpf4dgsQRJmtJPua1mEa_Registration%20List.png", "Registration List.png", "573", "138", "#0e97b3", "" ] } ] } [/block] Click on the Save Changes button. [block:api-header] { "type": "basic", "title": "Add New Students to a List and Group" } [/block] You can add new students to a MailChimp list and group when they register for a course. From the WordPress admin navigate to LifterLMS > Courses and choose the course for which you’d like to add students to a list and group. Click on “MailChimp Settings” in the blue menu. Select the list you’d like new students to be added to when they register for the course from the New Registration List dropdown field. If you’d like you can also select a group to add students to when they register for the course from the New Registration Group dropdown field. [block:image] { "images": [ { "image": [ "https://files.readme.io/NymGDATVQaCXDt1UTHDH_List%20and%20Group.png", "List and Group.png", "697", "392", "#34adcb", "" ] } ] } [/block] Click on the Update button to save your changes.