{"id":34,"date":"2016-07-10T12:11:44","date_gmt":"2016-07-10T12:11:44","guid":{"rendered":"https:\/\/dm.ua\/?page_id=34"},"modified":"2016-08-16T18:17:00","modified_gmt":"2016-08-16T18:17:00","slug":"documentation","status":"publish","type":"page","link":"https:\/\/dm.ua\/en\/documentation\/","title":{"rendered":"Documentation"},"content":{"rendered":"<main>\r\n<div class=\"container documentation\">\r\n<h1>API and documentation<\/h1>\r\n<div class=\"doc_section\">\r\n<div class=\"header_with_underline\">\r\n<h2>\r\nSubscribe\r\n<\/h2>\r\n<span class=\"pink_underline\">\r\n<\/span>\r\n<\/div>\r\n<span class=\"doc_url\">URL: https:\/\/dm.ua\/a\/subscribe<\/span>\r\n<h4>Parameters<\/h4>\r\n<p>Note: You can also pass values into custom fields. To add values to your desired custom field, use the personalization tag of the custom field as the parameter. Say, your custom field tag is [Birthday,fallback=], you can use the parameter, 'Birthday' to add values to this custom field.<\/p>\r\n<ol class=\"numbered_ul\">\r\n<li>\u00a0\u00a0 name <span>user's name is optional<\/span><\/li>\r\n<li>\u00a0\u00a0 email <span>user's email<\/span><\/li>\r\n<li>\u00a0\u00a0 list <span>the list id you want to subscribe a user to. This encrypted & hashed id can be found under View all lists section named ID<\/span><\/li>\r\n<li>\u00a0\u00a0 boolean <span>set this to \"true\" so that you'll get a plain text response<\/span><\/li>\r\n<\/ol>\r\n<h4>Response<\/h4>\r\n<ul>\r\n<li>\u00a0\u00a0 <span>Success:<\/span> true<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> Some fields are missing.<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> Invalid email address.<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> Invalid list ID.<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> Already subscribed.<\/li>\r\n<\/ul>\r\n<\/div>\r\n<div class=\"doc_section\">\r\n<div class=\"header_with_underline\">\r\n<h2>\r\nUnsubscribe\r\n<\/h2>\r\n<span class=\"pink_underline\">\r\n<\/span>\r\n<\/div>\r\n<span class=\"doc_url\">URL: https:\/\/dm.ua\/a\/unsubscribe<\/span>\r\n<p>This method unsubscribes a user from a list.<\/p>\r\n<h4>Parameters<\/h4>\r\n<ol class=\"numbered_ul\">\r\n<li>\u00a0\u00a0 email <span>user's email<\/span><\/li>\r\n<li>\u00a0\u00a0 list <span>the list id you want to subscribe a user to. This encrypted & hashed id can be found under View all lists section named ID<\/span><\/li>\r\n<li>\u00a0\u00a0 boolean <span>set this to \"true\" so that you'll get a plain text response<\/span><\/li>\r\n<\/ol>\r\n<h4>Response<\/h4>\r\n<ul>\r\n<li>\u00a0\u00a0 <span>Success:<\/span> true<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> Some fields are missing.<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> Invalid email address.<\/li>\r\n<\/ul>\r\n<\/div>\r\n<div class=\"doc_section\">\r\n<div class=\"header_with_underline\">\r\n<h2>\r\nSubscription status\r\n<\/h2>\r\n<span class=\"pink_underline\">\r\n<\/span>\r\n<\/div>\r\n<span class=\"doc_url\">URL: https:\/\/dm.ua\/a\/api\/subscribers\/subscription-status.php<\/span>\r\n<p>This method gets the current status of a subscriber (eg. subscribed, unsubscribed, bounced, complained).<\/p>\r\n<h4>Parameters<\/h4>\r\n<ol class=\"numbered_ul\">\r\n<li>\u00a0\u00a0 api_key <span>your API key, available in Settings.<\/span>\r\n<li>\u00a0\u00a0 email <span>user's email<\/span><\/li>\r\n<li>\u00a0\u00a0 list <span>the list id you want to subscribe a user to. This encrypted & hashed id can be found under View all lists section named ID<\/span><\/li><\/li>\r\n<\/ol>\r\n<h4>Response<\/h4>\r\n<ul>\r\n<li>\u00a0\u00a0 <span>Success:<\/span> Subscribed<\/li>\r\n<li>\u00a0\u00a0 <span>Success:<\/span> Unsubscribed<\/li>\r\n<li>\u00a0\u00a0 <span>Success:<\/span> Unconfirmed<\/li>\r\n<li>\u00a0\u00a0 <span>Success:<\/span> Bounced<\/li>\r\n<li>\u00a0\u00a0 <span>Success:<\/span> Soft bounced<\/li>\r\n<li>\u00a0\u00a0 <span>Success:<\/span> Complained<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> No data passed<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> API key not passed<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> Invalid API key<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> Email not passed<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> List ID not passed<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> Email does not exist in list<\/li>\r\n<\/ul>\r\n<\/div>\r\n<div class=\"doc_section\">\r\n<div class=\"header_with_underline\">\r\n<h2>\r\nActive subscriber count\r\n<\/h2>\r\n<span class=\"pink_underline\">\r\n<\/span>\r\n<\/div>\r\n<span class=\"doc_url\">URL: https:\/\/dm.ua\/a\/api\/subscribers\/active-subscriber-count.php<\/span>\r\n<p>This method gets the total active subscriber count.<\/p>\r\n<h4>Parameters<\/h4>\r\n<ol class=\"numbered_ul\">\r\n<li>\u00a0\u00a0 api_key <span>your API key, available in Settings.<\/span><\/li>\r\n<li>\u00a0\u00a0 list_id <span>the id of the list you want to get the active subscriber count. This encrypted id can be found under View all lists section named ID<\/span><\/li>\r\n<\/ol>\r\n<h4>Response<\/h4>\r\n<ul>\r\n<li>\u00a0\u00a0 <span>Success:<\/span> You'll get an integer of the active subscriber count<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> No data passed<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> API key not passed<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> Invalid API key<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> List ID not passed<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> List does not exist<\/li>\r\n<\/ul>\r\n<\/div>\r\n<div class=\"doc_section\">\r\n<div class=\"header_with_underline\">\r\n<h2>\r\nCreate and send campaign\r\n<\/h2>\r\n<span class=\"pink_underline\">\r\n<\/span>\r\n<\/div>\r\n<span class=\"doc_url\">URL: https:\/\/dm.ua\/a\/api\/campaigns\/create.php<\/span>\r\n<p>This method creates a campaign (with an option to send it too).<\/p>\r\n<h4>Parameters<\/h4>\r\n<ol class=\"numbered_ul\">\r\n<li>\u00a0\u00a0 api_key <span>your API key, available in Settings.<\/span><\/li>\r\n<li>\u00a0\u00a0 from_name <span>the 'From name' of your campaign<\/span><\/li>\r\n<li>\u00a0\u00a0 from_email <span>the 'From email' of your campaign<\/span><\/li>\r\n<li>\u00a0\u00a0 reply_to <span>the 'Reply to' of your campaign<\/span><\/li>\r\n<li>\u00a0\u00a0 subject <span>the 'Subject' of your campaign<\/span><\/li>\r\n<li>\u00a0\u00a0 plain_text <span>the 'Plain text version' of your campaign (optional)<\/span><\/li>\r\n<li>\u00a0\u00a0 html_text <span>the 'HTML version' of your campaign<\/span><\/li>\r\n<li>\u00a0\u00a0 list_ids <span>Required only if you set<\/span> send_campaign <span>to<\/span> 1 <span>to send the campaign and not just create a draft. List IDs should be single or comma-separated. The encrypted & hashed ids can be found under View all lists section named ID.<\/span><\/li>\r\n<li>\u00a0\u00a0 brand_id <span>Required only if you are creating a 'Draft' campaign (<\/span>send_campaign <span>set to 0 or left as default). Brand IDs can be found under 'Brands' page named ID<\/span><\/li>\r\n<li>\u00a0\u00a0 query_string <span>eg. Google Analytics tags<\/span><\/li>\r\n<li>\u00a0\u00a0 send_campaign <span>Set to<\/span> 1 <span>if you want to send the campaign as well and not just create a draft. Default is<\/span> 0<span>.<\/span><\/li>\r\n<\/ol>\r\n<h4>Response<\/h4>\r\n<ul>\r\n<li>\u00a0\u00a0 <span>Success:<\/span> Campaign created<\/li>\r\n<li>\u00a0\u00a0 <span>Success:<\/span> Campaign created and now sending<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> No data passed<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> API key not passed<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> Invalid API key<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> From name not passed<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> From email not passed<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> Reply to email not passed<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> Subject not passed<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> HTML not passed<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> List ID(s) not passed<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> One or more list IDs are invalid<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> List IDs does not belong to a single brand<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> Brand ID not passed<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> Unable to create campaign<\/li>\r\n<li>\u00a0\u00a0 <span>Error:<\/span> Unable to create and send campaign<\/li>\r\n<\/ul>\r\n<\/div>\r\n<\/div>","protected":false},"excerpt":{"rendered":"<p>API and documentation Subscribe URL: https:\/\/dm.ua\/a\/subscribe Parameters Note: You can also pass values into custom<a href=\"https:\/\/dm.ua\/en\/documentation\/\"> Read more&#8230;<\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":4,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-34","page","type-page","status-publish","hentry"],"translation":{"provider":"WPGlobus","version":"3.0.5","language":"en","enabled_languages":["ru","en","uk"],"languages":{"ru":{"title":true,"content":true,"excerpt":false},"en":{"title":false,"content":true,"excerpt":false},"uk":{"title":false,"content":true,"excerpt":false}}},"_links":{"self":[{"href":"https:\/\/dm.ua\/en\/wp-json\/wp\/v2\/pages\/34","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/dm.ua\/en\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/dm.ua\/en\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/dm.ua\/en\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/dm.ua\/en\/wp-json\/wp\/v2\/comments?post=34"}],"version-history":[{"count":33,"href":"https:\/\/dm.ua\/en\/wp-json\/wp\/v2\/pages\/34\/revisions"}],"predecessor-version":[{"id":135,"href":"https:\/\/dm.ua\/en\/wp-json\/wp\/v2\/pages\/34\/revisions\/135"}],"wp:attachment":[{"href":"https:\/\/dm.ua\/en\/wp-json\/wp\/v2\/media?parent=34"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}