{"id":599,"date":"2018-08-14T17:00:27","date_gmt":"2018-08-14T16:00:27","guid":{"rendered":"http:\/\/www.earlyparrot.com\/support\/?post_type=kbe_knowledgebase&p=599"},"modified":"2019-06-03T09:01:15","modified_gmt":"2019-06-03T08:01:15","slug":"earlyparrot-api-how-to-add-a-new-subscriber-to-an-earlyparrot-referral-campaign","status":"publish","type":"kbe_knowledgebase","link":"https:\/\/www.earlyparrot.com\/support\/kb\/earlyparrot-api-how-to-add-a-new-subscriber-to-an-earlyparrot-referral-campaign\/","title":{"rendered":"EarlyParrot API – How to add a new subscriber to an EarlyParrot referral campaign"},"content":{"rendered":"

You can add subscribers to any campaign by directly calling EarlyParrot API as follows.<\/p>\n

Method 1: Call subscribe API directly from JavaScript<\/h3>\n

Method:\u00a0<\/strong>POST<\/p>\n

Param:\u00a0<\/strong><\/p>\n

var ep_subscribeObj = new Object();\nep_subscribeObj.firstName = 'Gaetano';  \/\/ ' ' if not available\nep_subscribeObj.lastName = 'Caruana'; \/\/ ' ' if not available\nep_subscribeObj.email = 'gaetano@earlyparrot.com'  \/\/ Mandatory
ep_subscribeObj.rh = Cookies.get('rh');\n<\/pre>\n
URL:\u00a0<\/strong>https:\/\/admin.earlyparrot.com\/api\/campaigns\/[YOUR_CAMPAIGN_ID<\/strong>]\/subscribe<\/p>\n
Both if the supplied email is a subscriber or not, you will get the following JSON response:<\/p>\n
{\n...\n  \"user\": {\n    \"_id\": \"5a5b28f21b2f10001f6e6c20\",\n    \"profileImageURL\": \"https:\/\/lh3.googleusercontent.com\/-CLCe_GG_Mbo\/AAAAAAAAAAI\/AAAAAAAAABA\/WfAB5P5zNoE\/photo.jpg?sz=500\",\n    \"confirmationToken\": \"c505a5c561fa4eaa5ca0eaa7cc4110ed5a5b28f21b2f10001f6e6c20\",<\/strong>\n...\n    \"username\": \"gaetano\",\n    \"displayName\": \"Gaetano Caruana\",\n    \"welcomeEmailSent\": false,\n...\n  \n    \"email\": \"gaetano@earlyparrot.com\",\n...\n\n    \"id\": \"5a5b28f21b2f10001f6e6c20\",\n...\n  },\n  \"sharePage\": \"[YOUR_SHARE_PAGE_URL]?confirm-subscribe=c505a5c561fa4eaa5ca0eaa7cc4110ed5a5b28f21b2f10001f6e6c20\"<\/strong>\n}\n<\/pre>\n
The\u00a0confirmationToken<\/strong> can be persisted as it will never change for a given subscriber.<\/p>\n
It is completely safe to call subscribe call multiple times. EarlyParrot will make sure not to duplicate your subscribers but it will simply return the information about the subscriber.<\/p>\n
\u00a0<\/p>\n
Method 2: Using Google Tag Manager to call add subscriber call<\/h3>\n
Google Tag Manager will allow you to install, test, deploy and even rollback scripts with ease. Once you have Google Tag Manager installed, you are ready to install and deploy EarlyParrot scripts including binding to a form to capture new sign-ups. Log into your Google Tag Manager and go to\u00a0Triggers<\/strong>\u00a0tab.<\/p>\n
\"\"<\/p>\n
Create a new trigger new\u00a0Page View trigger.<\/strong><\/p>\n
\"\"<\/p>\n
Call it\u00a0EarlyParrot Subscriber Page Trigger<\/strong>. Set the trigger condition to make sure it triggers only on the page that has the sign-up form on it.<\/p>\n
\u00a0<\/p>\n
\"\"<\/figure>\n
\u00a0<\/p>\n
Go to\u00a0Triggers<\/strong>\u00a0tab again.<\/p>\n
\"\"<\/p>\n
Create a new trigger new\u00a0Event Trigger.<\/strong><\/p>\n
\u00a0<\/p>\n
\"\"<\/figure>\n
<\/figure>\n
\u00a0<\/p>\n
Call it\u00a0subscribeCallUtilitiesLoaded<\/strong>.\u00a0<\/p>\n
\"\"<\/p>\n
Then go the\u00a0tags<\/strong>\u00a0tab.<\/p>\n
\"\"<\/p>\n
Create a new\u00a0Custom HTML tag.<\/strong><\/p>\n
\"\"Call it\u00a0EarlyParrot Subscribe Call Step1<\/strong>\u00a0and paste the following script.<\/p>\n\n\n
<script language=\"javascript\">\n    (function(w,d,url){\n        var headElement=d.getElementsByTagName('head')[0];\n        var scriptElement=d.createElement('script');\n        scriptElement.addEventListener('load', function() {\n            window.dataLayer.push({\n                event: 'subscribeCallUtiltiesLoaded'\n            });\n        });\n        scriptElement.async=1;\n        scriptElement.src=url\n        headElement.appendChild(scriptElement);\n    })(window,document,'https:\/\/s3.amazonaws.com\/earlyparrot-production-scripts\/utilities.js');\n<\/script>\n<\/code><\/pre>\n\n\n\n
This script will load required utilities.js<\/strong> file. Once this tag has been added go ahead and add another set the trigger to EarlyParrot Subscriber Page Trigger.<\/strong><\/p>\n\n\n\n
\"\"<\/figure><\/div>\n\n\n\n
Create another Custom HTML tag and call it EarlyParrot Subscribe Call Step2. <\/strong>Place this snippet of code in the custom HTML tag you just created. Now this snippet of code needs some editing.<\/p>\n\n\n\n
  • Use JQuery to capture the value of first name, last name and email. Both first name and last name are optional but email is mandatory.<\/li>
  • replace your [YOUR_CAMPAIGN_ID] with your own CampaignId<\/li><\/ul>\n\n\n\n
    If you require any assitance to modify the script please do get in touch with us on support@earlyparrot.com. Our software developers will help you out.<\/em><\/p>\n\n\n\n
    <script language=\"javascript\">\nepJQuery('form').submit(function(e) {\n  \n    var ep_subscribeObj = new Object();\n    epJQuery(\"input[name='first_name']\").each(function(index, value) {\n      if (epJQuery(value).val() != null && epJQuery(value).val().length > 0) {\n          ep_subscribeObj.firstName = epJQuery(value).val();\n      }\n    });\n    epJQuery(\"input[name='last_name']\").each(function(index, value) {\n      if (epJQuery(value).val() != null && epJQuery(value).val().length > 0) {\n          ep_subscribeObj.lastName = epJQuery(value).val();\n      }\n    });\n    epJQuery(\"input[name='email']\").each(function(index, value) {\n      if (epJQuery(value).val() != null && epJQuery(value).val().length > 0) {\n          ep_subscribeObj.email = epJQuery(value).val();\n      }\n    });\n    ep_subscribeObj.rh = Cookies.get('rh');\n    ep_subscribeObj.sendWelcomeImmediately = 0; \/\/will not send welcome email \n    \n    Cookies.set('epSubmitEmail', ep_subscribeObj.email, { domain: 'yourdomain.com' });\n  \n  epJQuery.post(\"https:\/\/admin.earlyparrot.com\/api\/campaigns\/[YOUR_CAMPAIGN_ID]\/subscribe\", ep_subscribeObj)\n      .then(function(data) {\n           \/\/JSON object returned by subscribe call\n           var userFirstName = data.user.firstName;\n           var userLastName = data.user.lastName;\n           var userEmail = data.user.email;\n           var sharePageURL = data.sharePage;\n    \n            var confirmationToken = data.user.confirmationToken;\n        \tvar domain=document.domain;\n            var p=domain.split('.');\n            var i=0;\n            var current_domain='';\n\n            for (var i=0;i<p.length-1;i++) { \n              current_domain = p.slice(i).join('.');\n              Cookies.set('confirmToken', confirmationToken, { domain: current_domain });\n            }\n    \n\t   window.dataLayer.push({\n              'userFirstName': userFirstName,\n              'userLastName': userLastName,\n              'userEmail': userEmail,\n              'sharePageURL': sharePageURL\n            });   \n       });\n});  \n<\/script><\/code><\/pre>\n\n\n\n
    Set the trigger to subscribeCallUtilitiesLoaded<\/strong> event.<\/p>\n\n\n\n
    \"\"<\/figure><\/div>\n\n\n\n
    With that set, you are ready to roll.<\/p>\n","protected":false},"excerpt":{"rendered":"
    You can add subscribers to any campaign by directly calling EarlyParrot API as follows. Method 1: Call subscribe API directly from JavaScript Method:\u00a0POST Param:\u00a0 var ep_subscribeObj = new Object(); ep_subscribeObj.firstName = ‘Gaetano’; \/\/ ‘ ‘ if not available ep_subscribeObj.lastName = ‘Caruana’; \/\/ ‘ ‘ if not available ep_subscribeObj.email = ‘gaetano@earlyparrot.com’ \/\/ Mandatoryep_subscribeObj.rh = Cookies.get(‘rh’); URL:\u00a0https:\/\/admin.earlyparrot.com\/api\/campaigns\/[YOUR_CAMPAIGN_ID]\/subscribe […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","template":"","kbe_taxonomy":[12,13],"kbe_tags":[],"yoast_head":"\nEarlyParrot API - How to add a new subscriber to an EarlyParrot referral campaign<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.earlyparrot.com\/support\/kb\/earlyparrot-api-how-to-add-a-new-subscriber-to-an-earlyparrot-referral-campaign\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"EarlyParrot API - How to add a new subscriber to an EarlyParrot referral campaign\" \/>\n<meta property=\"og:description\" content=\"You can add subscribers to any campaign by directly calling EarlyParrot API as follows. Method 1: Call subscribe API directly from JavaScript Method:\u00a0POST Param:\u00a0 var ep_subscribeObj = new Object(); ep_subscribeObj.firstName = 'Gaetano'; \/\/ ' ' if not available ep_subscribeObj.lastName = 'Caruana'; \/\/ ' ' if not available ep_subscribeObj.email = 'gaetano@earlyparrot.com' \/\/ Mandatoryep_subscribeObj.rh = Cookies.get('rh'); URL:\u00a0https:\/\/admin.earlyparrot.com\/api\/campaigns\/[YOUR_CAMPAIGN_ID]\/subscribe […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.earlyparrot.com\/support\/kb\/earlyparrot-api-how-to-add-a-new-subscriber-to-an-earlyparrot-referral-campaign\/\" \/>\n<meta property=\"og:site_name\" content=\"EarlyParrot Support\" \/>\n<meta property=\"article:modified_time\" content=\"2019-06-03T08:01:15+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/www.earlyparrot.com\/support\/wp-content\/uploads\/2018\/07\/gtm-landing-page-1.png\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"4 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https:\/\/www.earlyparrot.com\/support\/#organization\",\"name\":\"EarlyParrot\",\"url\":\"https:\/\/www.earlyparrot.com\/support\/\",\"sameAs\":[],\"logo\":{\"@type\":\"ImageObject\",\"@id\":\"https:\/\/www.earlyparrot.com\/support\/#logo\",\"inLanguage\":\"en-US\",\"url\":\"https:\/\/www.earlyparrot.com\/support\/wp-content\/uploads\/2022\/02\/parrot.png\",\"contentUrl\":\"https:\/\/www.earlyparrot.com\/support\/wp-content\/uploads\/2022\/02\/parrot.png\",\"width\":1500,\"height\":1774,\"caption\":\"EarlyParrot\"},\"image\":{\"@id\":\"https:\/\/www.earlyparrot.com\/support\/#logo\"}},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.earlyparrot.com\/support\/#website\",\"url\":\"https:\/\/www.earlyparrot.com\/support\/\",\"name\":\"EarlyParrot Support\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\/\/www.earlyparrot.com\/support\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.earlyparrot.com\/support\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"ImageObject\",\"@id\":\"https:\/\/www.earlyparrot.com\/support\/kb\/earlyparrot-api-how-to-add-a-new-subscriber-to-an-earlyparrot-referral-campaign\/#primaryimage\",\"inLanguage\":\"en-US\",\"url\":\"https:\/\/www.earlyparrot.com\/support\/wp-content\/uploads\/2018\/07\/gtm-landing-page-1.png\",\"contentUrl\":\"https:\/\/www.earlyparrot.com\/support\/wp-content\/uploads\/2018\/07\/gtm-landing-page-1.png\"},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.earlyparrot.com\/support\/kb\/earlyparrot-api-how-to-add-a-new-subscriber-to-an-earlyparrot-referral-campaign\/#webpage\",\"url\":\"https:\/\/www.earlyparrot.com\/support\/kb\/earlyparrot-api-how-to-add-a-new-subscriber-to-an-earlyparrot-referral-campaign\/\",\"name\":\"EarlyParrot API - How to add a new subscriber to an EarlyParrot referral campaign\",\"isPartOf\":{\"@id\":\"https:\/\/www.earlyparrot.com\/support\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/www.earlyparrot.com\/support\/kb\/earlyparrot-api-how-to-add-a-new-subscriber-to-an-earlyparrot-referral-campaign\/#primaryimage\"},\"datePublished\":\"2018-08-14T16:00:27+00:00\",\"dateModified\":\"2019-06-03T08:01:15+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/www.earlyparrot.com\/support\/kb\/earlyparrot-api-how-to-add-a-new-subscriber-to-an-earlyparrot-referral-campaign\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.earlyparrot.com\/support\/kb\/earlyparrot-api-how-to-add-a-new-subscriber-to-an-earlyparrot-referral-campaign\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.earlyparrot.com\/support\/kb\/earlyparrot-api-how-to-add-a-new-subscriber-to-an-earlyparrot-referral-campaign\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.earlyparrot.com\/support\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Knowledgebase\",\"item\":\"https:\/\/www.earlyparrot.com\/support\/kb\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"EarlyParrot API – How to add a new subscriber to an EarlyParrot referral campaign\"}]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"EarlyParrot API - How to add a new subscriber to an EarlyParrot referral campaign","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.earlyparrot.com\/support\/kb\/earlyparrot-api-how-to-add-a-new-subscriber-to-an-earlyparrot-referral-campaign\/","og_locale":"en_US","og_type":"article","og_title":"EarlyParrot API - How to add a new subscriber to an EarlyParrot referral campaign","og_description":"You can add subscribers to any campaign by directly calling EarlyParrot API as follows. Method 1: Call subscribe API directly from JavaScript Method:\u00a0POST Param:\u00a0 var ep_subscribeObj = new Object(); ep_subscribeObj.firstName = 'Gaetano'; \/\/ ' ' if not available ep_subscribeObj.lastName = 'Caruana'; \/\/ ' ' if not available ep_subscribeObj.email = 'gaetano@earlyparrot.com' \/\/ Mandatoryep_subscribeObj.rh = Cookies.get('rh'); URL:\u00a0https:\/\/admin.earlyparrot.com\/api\/campaigns\/[YOUR_CAMPAIGN_ID]\/subscribe […]","og_url":"https:\/\/www.earlyparrot.com\/support\/kb\/earlyparrot-api-how-to-add-a-new-subscriber-to-an-earlyparrot-referral-campaign\/","og_site_name":"EarlyParrot Support","article_modified_time":"2019-06-03T08:01:15+00:00","og_image":[{"url":"https:\/\/www.earlyparrot.com\/support\/wp-content\/uploads\/2018\/07\/gtm-landing-page-1.png"}],"twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"4 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Organization","@id":"https:\/\/www.earlyparrot.com\/support\/#organization","name":"EarlyParrot","url":"https:\/\/www.earlyparrot.com\/support\/","sameAs":[],"logo":{"@type":"ImageObject","@id":"https:\/\/www.earlyparrot.com\/support\/#logo","inLanguage":"en-US","url":"https:\/\/www.earlyparrot.com\/support\/wp-content\/uploads\/2022\/02\/parrot.png","contentUrl":"https:\/\/www.earlyparrot.com\/support\/wp-content\/uploads\/2022\/02\/parrot.png","width":1500,"height":1774,"caption":"EarlyParrot"},"image":{"@id":"https:\/\/www.earlyparrot.com\/support\/#logo"}},{"@type":"WebSite","@id":"https:\/\/www.earlyparrot.com\/support\/#website","url":"https:\/\/www.earlyparrot.com\/support\/","name":"EarlyParrot Support","description":"","publisher":{"@id":"https:\/\/www.earlyparrot.com\/support\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.earlyparrot.com\/support\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"},{"@type":"ImageObject","@id":"https:\/\/www.earlyparrot.com\/support\/kb\/earlyparrot-api-how-to-add-a-new-subscriber-to-an-earlyparrot-referral-campaign\/#primaryimage","inLanguage":"en-US","url":"https:\/\/www.earlyparrot.com\/support\/wp-content\/uploads\/2018\/07\/gtm-landing-page-1.png","contentUrl":"https:\/\/www.earlyparrot.com\/support\/wp-content\/uploads\/2018\/07\/gtm-landing-page-1.png"},{"@type":"WebPage","@id":"https:\/\/www.earlyparrot.com\/support\/kb\/earlyparrot-api-how-to-add-a-new-subscriber-to-an-earlyparrot-referral-campaign\/#webpage","url":"https:\/\/www.earlyparrot.com\/support\/kb\/earlyparrot-api-how-to-add-a-new-subscriber-to-an-earlyparrot-referral-campaign\/","name":"EarlyParrot API - How to add a new subscriber to an EarlyParrot referral campaign","isPartOf":{"@id":"https:\/\/www.earlyparrot.com\/support\/#website"},"primaryImageOfPage":{"@id":"https:\/\/www.earlyparrot.com\/support\/kb\/earlyparrot-api-how-to-add-a-new-subscriber-to-an-earlyparrot-referral-campaign\/#primaryimage"},"datePublished":"2018-08-14T16:00:27+00:00","dateModified":"2019-06-03T08:01:15+00:00","breadcrumb":{"@id":"https:\/\/www.earlyparrot.com\/support\/kb\/earlyparrot-api-how-to-add-a-new-subscriber-to-an-earlyparrot-referral-campaign\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.earlyparrot.com\/support\/kb\/earlyparrot-api-how-to-add-a-new-subscriber-to-an-earlyparrot-referral-campaign\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.earlyparrot.com\/support\/kb\/earlyparrot-api-how-to-add-a-new-subscriber-to-an-earlyparrot-referral-campaign\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.earlyparrot.com\/support\/"},{"@type":"ListItem","position":2,"name":"Knowledgebase","item":"https:\/\/www.earlyparrot.com\/support\/kb\/"},{"@type":"ListItem","position":3,"name":"EarlyParrot API – How to add a new subscriber to an EarlyParrot referral campaign"}]}]}},"_links":{"self":[{"href":"https:\/\/www.earlyparrot.com\/support\/wp-json\/wp\/v2\/kbe_knowledgebase\/599"}],"collection":[{"href":"https:\/\/www.earlyparrot.com\/support\/wp-json\/wp\/v2\/kbe_knowledgebase"}],"about":[{"href":"https:\/\/www.earlyparrot.com\/support\/wp-json\/wp\/v2\/types\/kbe_knowledgebase"}],"author":[{"embeddable":true,"href":"https:\/\/www.earlyparrot.com\/support\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.earlyparrot.com\/support\/wp-json\/wp\/v2\/comments?post=599"}],"version-history":[{"count":21,"href":"https:\/\/www.earlyparrot.com\/support\/wp-json\/wp\/v2\/kbe_knowledgebase\/599\/revisions"}],"predecessor-version":[{"id":863,"href":"https:\/\/www.earlyparrot.com\/support\/wp-json\/wp\/v2\/kbe_knowledgebase\/599\/revisions\/863"}],"wp:attachment":[{"href":"https:\/\/www.earlyparrot.com\/support\/wp-json\/wp\/v2\/media?parent=599"}],"wp:term":[{"taxonomy":"kbe_taxonomy","embeddable":true,"href":"https:\/\/www.earlyparrot.com\/support\/wp-json\/wp\/v2\/kbe_taxonomy?post=599"},{"taxonomy":"kbe_tags","embeddable":true,"href":"https:\/\/www.earlyparrot.com\/support\/wp-json\/wp\/v2\/kbe_tags?post=599"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}