The FeedBlitz API 3.0 The FeedBlitz API Version 3.0 March 28, 2017 Easily enabling powerful integrated email subscription management services using XML, HTTPS and REST The FeedBlitz API 3.0 The FeedBlitz API The FeedBlitz API ...................................................................................................................... i Copyright .............................................................................................................................. iv Disclaimer ............................................................................................................................. iv About FeedBlitz ......................................................................................................................v Change History .......................................................................................................................v Integrating FeedBlitz: APIs and More .........................................................................................1 Example: Building a Subscription Plugin for FeedBlitz ...............................................................1 Prerequisites ............................................................................................................................1 Workflow ................................................................................................................................2 In Detail ..................................................................................................................................2 1. Get a List of Active Mailing Lists ..............................................................................2 2. Get Active Custom Fields ..........................................................................................2 3. Subscribe the Visitor .................................................................................................3 Code Sample ...............................................................................................................................3 The FeedBlitz Simple API Reference ..........................................................................................6 Adding an email address to a list .............................................................................................6 Examples .............................................................................................................................7 What Happens .....................................................................................................................7 Unsubscribing a Subscriber .....................................................................................................8 Setting a Custom Field Value ..................................................................................................8 Examples:............................................................................................................................8 The FeedBlitz REST API ............................................................................................................9 API Design and Usage Considerations ....................................................................................9 Privacy and Security .............................................................................................................. 10 Accessing the API ..................................................................................................................... 10 Example usage: ..................................................................................................................... 11 Basic FeedBlitz API XML .................................................................................................... 11 API Methods ......................................................................................................................... 12 GET – Read Data .............................................................................................................. 12 POST – Edit and Search .................................................................................................... 13 DELETE – Resource Removal .......................................................................................... 13 PUT – Add a New Resource .............................................................................................. 14 Sample API Interactions ........................................................................................................ 14 Using FeedBlitz Functionality: Adding Email Services to Your Online Application .......... 14 Adding Custom Validation to Email Signup ...................................................................... 15 Testing the API ..................................................................................................................... 15 FeedBlitz API RESOURCE REFERENCE GUIDE .................................................................. 16 Subscribers (Subscriber Management)....................................................................................... 16 GET – Fetching Subscriber Information ................................................................................ 17 POST - Searching and sorting subscribers ............................................................................. 17 POST – Editing Subscribers .................................................................................................. 18 DELETE – Deleting a subscriber’s subscription .................................................................... 19 PUT - Adding a new subscriber ............................................................................................. 20 Subscriptions (Managing the Updates you Receive) .................................................................. 20 GET – Fetching Subscription Information ............................................................................. 22 i The FeedBlitz API 3.0 POST - Searching Subscriptions ............................................................................................ 22 POST – Editing Subscriptions ............................................................................................... 23 DELETE – Deleting a subscription........................................................................................ 23 PUT - Adding a new subscription .......................................................................................... 23 Syndications .............................................................................................................................. 24 GET – Fetching Syndication Data ......................................................................................... 26 Summarizing Syndications ................................................................................................ 27 POST – Searching Syndications ............................................................................................ 27 POST – Editing Syndications ................................................................................................ 28 DELETE – Deleting Syndications ......................................................................................... 28 PUT – Creating a New Syndication ....................................................................................... 28 Captcha (Image Verification) .................................................................................................... 29 User (Account registration and Subscription Signup) ................................................................ 29 GET – About the Current User .............................................................................................. 29 POST – Updating the Current User ....................................................................................... 30 PUT – Registering a New User Account ................................................................................ 31 PUT – A New Subscription to an Existing Syndication ......................................................... 31 DELETE – Deleting a User ................................................................................................... 32 Autoresponders (aka Funnels) ................................................................................................... 32 Time Zones ............................................................................................................................... 33 Dynamic Ad and Metric Insertion ............................................................................................. 33 Mailing Resources..................................................................................................................... 34 Newsflash ............................................................................................................................. 34 On Demand ........................................................................................................................... 35 SendMail – Send a one-off email to a single subscriber ......................................................... 37 Email Design Templates ........................................................................................................... 39 Report Resource ........................................................................................................................ 39 Mailing Metrics Resource ........................................................................................................