Sendlane - API Reference



Similar documents
Campaigns. Product Use Guide. Copyright LeadFormix Inc. All Rights Reserved

LICENTIA. Nuntius. Magento Marketing Extension REVISION: THURSDAY, JUNE 2, 2016 (V )

Getting Started Quick Guide. enews.miclub.com.au. MiClub : Enews Manual

LICENTIA. Nuntius. Magento Marketing Extension REVISION: SEPTEMBER 21, 2015 (V1.8.1)

In order for the form to process and send correctly the follow objects must be in the form tag.

Using Your New Webmail

XYZ NEWSLETTER MANAGER A Wordpress Plugin

The VerticalResponse API Guide

Using Webmail. Technical Manual: User Guide. Document Updated: 1/07. The Webmail Window. Displaying and Hiding the Full Header.

API Guide v /11/2013

How to Create and Send Newsletter Using G-Lock EasyMail

Configuring Mozilla Thunderbird to Access Your SAS Account

Campaign Monitor. Quick Reference Guid e

Webmail User Guide. The Webmail Window. Logging In to Webmail. Displaying and Hiding the Full Header. Printing an . Composing a New

Composite.Community.Newsletter - User Guide

Using Your New Webmail

Pinpointe User s Guide

DIY Manager User Guide.

Frequently Asked Questions for New Electric Mail Administrators 1 Domain Setup/Administration

Contents CHAPTER 1 IMail Utilities

What browsers can I use to view my mail?

A quick guide to... Setting Up Your Campaigns

Webmail Instruction Guide

Marketing. User Guide. July Welcome to AT&T Website Solutions SM

Policy Based Encryption Gateway. Administration Guide

Grant Management System Training Guide Module 9 Notification Center Home Dashboard Ver 6.1 Updated:

ListManager Discussion Forums

UAE Bulk System. User Guide

Overview. How It Works

Webmail Friends & Exceptions Guide

ModusMail Software Instructions.

Policy Patrol 7 Upgrade Guide

Wakefield Council Secure and file transfer User guide for customers, partners and agencies

Messaging API. API Specification Document Messaging API. Functionality: Send SMS Messages.

MyMobileAPI. mymobileapi.com

Table of Contents. Overview Supported Platforms Demos/Downloads Known Issues Note Included Files...

Spambrella SaaS Encryption Enablement for Customers, Domains and Users Quick Start Guide

Table of Contents. Table of Contents 3

Mailchimp Integration Addon

API Integration Payment21 Button

-- Reading and Printing

Follow Up Pro Guide

Direct Mail Tutorial

NetSuite Customer Center Portal Tutorial

BlackBerry Internet Service Using the Browser on Your BlackBerry Smartphone Version: 2.8

G-Lock EasyMail7. Startup Guide. Client-Server Marketing Solution for Windows. To learn more about G-Lock EasyMail7, visit

WebCUR ListServ. ListServ Help Manual

Page 1 of 5. How to unblock automatic picture downloads in messages you receive

POP3 Connector for Exchange - Configuration

Helpdesk for JIRA

Unsubscribe and Bounce Management

PolyU Staff Service. Mailing List Management. User Guide

Training Manual. Version 6

ConvincingMail.com Marketing Solution Manual. Contents

Using Webmail. Document Updated: 9/08. Technical Manual: User Guide. The Webmail Window. Displaying and Hiding the Full Header.

Cloud Services. Cloud Control Panel. Admin Guide

emobile Bulk Text User Guide Copyright Notice Copyright Phonovation Ltd

Chapter 10 Encryption Service

Using CSI s Web Messaging System: Imail URL: mail.csi.cuny.edu

User Guide for Kelani Mail

Using Webmail. Document Updated: 11/10. Technical Manual: User Guide. The Webmail Window. Logging In to Webmail. Displaying and Hiding the Full Header

INTRODUCTION... 3 JNEWS... 5 LISTS... 6 SUBSCRIBERS NEWSLETTERS SMART-NEWSLETTERS / AUTO-RESPONDERS MEDIA MANAGER...

ANZ Secure Gateway Virtual Terminal QUICK REFERENCE GUIDE NOVEMBER 2015

INTERSPIRE MARKETER

For detailed information on these options and more, please read the appropriately titled topic in this help document.

Composite.Community.Newsletter - User Guide

Create an Campaign. Create & Send Your Newsletter

Tracking Campaigns with G-Lock Analytics

Sign in to Outlook Web App

Collax Mail Server. Howto. This howto describes the setup of a Collax server as mail server.

Table of Contents. Starting ListManager... 5 Logging In and Logging Out... 6 Your First List... 7 Homepage... 8

Bitrix Site Manager 4.0. Quick Start Guide to Newsletters and Subscriptions

Direct Mail Tutorial

Wharf T&T bmail 2010 bmail End User Guide Version 1.0

Web Mail Classic Web Mail

Listserv Mailing List Owner Quick Start Guide

Vodafone Business Product Management Group. Hosted Services Announcer Pro V4.6 User Guide

FAQ for List Owners/Moderators

5.2.3 Thank you message Bounce settings Step 6: Subscribers 6.1. Creating subscriber lists 6.2. Add subscribers Manual add 6.2.

Vodafone Bulk Text. User Guide. Copyright Notice. Copyright Phonovation Ltd

About the Junk Filter

Outlook Live Basics. for Students

Cloud. Hosted Exchange Administration Manual

Microsoft Outlook 2010 contains a Junk Filter designed to reduce unwanted messages in your

Sending an through Convio can be accomplished by the following six steps:

Exporting Addresses. for Use in Outlook Express

Software User s Guide

AJ Shopping Cart. Administration Manual

Lyris ListManager Tutorial

1. Starting the management of a subscribers list with emill

Reading mail via the Web on Mail.uh.edu

DPW ENTERPRISES Web Design and Hosting Services Autoresponder Software User s Guide

Logging into the control panel

TABLE OF CONTENTS. Creating an Account Why Use enewsletters. Setting Up an enewsletter Account. Create/Send Logging In.

1: 2: : 3.1: 3.2: 4: 5: & CAPTCHA

Transcription:

Sendlane - API Reference Version: v1 Document for the API to create / export / delete Subscribers / Send Mail / create List/ update List/ delete List/ get List/. /api/v1/list subscribers add To add Multiple subscribers with single list. /api/v1/subscribers delete To delete email from given lists /api/v1/send mail To delete email from given lists /api/v1/list create To create list /api/v1/list update To update list / api/v1/list delete To delete list /api/v1/lists To get lists /api/v1/autoresponders To fetch autoresponders /api/v1/autoresponder create To create autoresponders /api/v1/autoresponder confirm To confirm autoresponder /api/v1/autoresponder update To confirm autoresponder /api/v1/ user create To create user account /api/v1/ user update To update user account /api/v1/ opt in form To fetch optin form /api/v1/ opt in create To create optin form /api/v1/subscriber export To export subscriber

/api/v1/list-subscribers-add To add Multiple subscribers with single list. api Your API key provided hash md5(your_login_email.api). MD5 of your email and api key provided email Email format should be like the following and separated by comma firstname lastname<test@gmail.com>,firstname lastname<test1@gmail.com> or firstname< test@gmail.com >,firstname<test1@gmail.c om> or < test@gmail.com >, <test1@gmail.com> or test@gmail.com, test1@gmail.com Valid email list_id Valid list_id /api/v1/subscribers-delete To delete subscriber from given lists. api Your API key provided hash md5(your_login_email.api). MD5 of your email and api key provided list_id list_id s separated by comma, where the subscriber

email belongs to multiple list (listid_1, listid_2,...) Valid list_id email Subscriber email to delete. (Single email) Valid email /api/v1/send-mail To send mails. api Your API key provided hash Your Hash provided sender_name Receiver's Name sender_email Receiver's email Valid email receipent_name Sting Sender Name receipent_email Sring Sender email Valid email cc_email Sting Carbon Copy Email Valid email bcc_email Blind Carbon Copy Email Valid email subject Sting Subject for the Mail reply_to_email Reply to email Valid email content_html Body of the message (Html tags allowed) content_plain_text Body Of the message in plain ( Html Tags) (, if content_html not exists) track_opens eger To track email is opened 1 - track; 0 - Will not track (0 - Default) track_clicks eger To track the links send in the email 1- track; 0 -will not track (0 - Default) track_plain_text_clicks eger To track the links send in the email 1- track; 0 -will not track (0 - Default)

track_google_analytics_lin k eger 1- track; 0 -will not track (0 - Default) google_analytics_key Empty By Default /api/v1/list-create To create list. api Your API key provided hash md5(your_login_email.api). MD5 of your email and api key provided list_name List name will be unique and it will be not allow duplicate list names from_name From name may not be greater than 100 characters it will not allow regular expressions like "/^[^\"<>@]+$/" reply_email Reply email Yahoo/AOL reject emails that claim to come from yahoo/aol but actually originate at non-yahoo/aol servers Valid email default_reply_email Default Reply email Yahoo/AOL reject emails that claim to come from yahoo/aol but actually originate at non-yahoo/aol servers Valid email subject Enter the subject short_reminder Enter the description company Enter the company name address Enter the Address city Enter the city

zipcode Enter the zipcode country Enter the country state Enter the state phone eger Enter phone number Valid phone /api/v1/list-update To update list. api Your API key provided hash md5(your_login_email.api). MD5 of your email and api key provided list_id eger Enter valid list id from_name From name may not be greater than 100 characters it will not allow regular expressions like "/^[^\"<>@]+$/" reply_email Reply email Yahoo/AOL reject emails that claim to come from yahoo/aol but actually originate at non-yahoo/aol servers Valid email default_reply_email Default Reply email Yahoo/AOL reject emails that claim to come from yahoo/aol but actually originate at non-yahoo/aol servers Valid email subject Enter the subject short_reminder Enter the description company Enter the company name

address Enter the Address city Enter the city zipcode Enter the zipcode country Enter the country state Enter the state phone eger Enter phone number Valid phone /api/v1/list-delete To delete list. api Your API key provided hash md5(your_login_email.api). MD5 of your email and api key provided list_id eger Enter valid list id /api/v1/lists To get lists. api Your API key provided hash md5(your_login_email.api). MD5 of your email and api key provided list_id eger Enter valid list id start eger Start limit from

limit eger End limit to /api/v1/autoresponders To fetch details of autoresponders. api Your API key provided hash md5(your_login_email.api). MD5 of your email and api key provided autoresponder_id autoresponder_type 1 - Regular, 2 - Plain-text. title list_id list_id should be valid and exists. status 'tstarted', 'Progressing', 'Cancelled', 'Completed', 'Draft', 'Deleted', 'Scheduled', 'Stop'. Choose any one. start Record start from page. lmiit Total records you want to fetch. /api/v1/autoresponder-create To create a new autoresponder. api Your API key provided hash md5(your_login_email.api). MD5 of your email and api key provided autoresponder_type Regular or Plain-text. Choose any one list_id Format should be ( list_id_1:segment_id_1, list_id_1:segment_id_2, list_id_2:segment_id_3,..)

event_id event_id should be any one from (1, 2, 3, 4) 1 - Subscription to list 2 - Campaign is opened 3 - Any link in campaign is clicked campaign_id specific_link_clicked / / 4 - Specific link in campaign is clicked Required only when (event_id!= 1) Required only when (event_id = 4) autoresponder_send Should be like ( within the hour, 1 days, 1 week, 1 month, 1 year ) schedule_time Should be like 00:00:00 schedule_day schedule_day should be any one from (1, 2, 3, 4, 5, 6, 7) Weekdays from sunday to saturday. subject Campaign subject. Required if list_id does not have default subject. Limit: 150 chars from_name Limit: 100 chars Keep it relevant and non-spammy to avoid spam filters. Special chars " < > @ not allowed This is who your emails will come from. Use something they'll instantly recognize, like your company name. from_email Default reply-to email of the list A verified email address title Name of the campaign Replies to your campaign will go to this email address. content HTML Content of the campaign content_plain_text Required, if `campaign_type` = 2 (plain-text) Plain-text content of the campaign google_analytics_link_t racking, (by default )

google_analytics_key track_opens, (by default ) track_clicks, (by default ) track_plain_text_clicks, (by default ) attachment File Accept only PDF//txt files /api/v1/autoresponder-confirm To confirm autoresponder. api Your API key provided hash md5(your_login_email.api). MD5 of your email and api key provided autoresponder_id autoresponder_type Regular or Plain-text. Choose any one event_id event_id should be any one from (1, 2, 3, 4) 1 - Subscription to list 2 - Campaign is opened 3 - Any link in campaign is clicked campaign_id specific_link_clicked / / 4 - Specific link in campaign is clicked Required only when (event_id!= 1) Required only when (event_id!= 4) autoresponder_send Should be like ( within the hour, 1 days, 1 week, 1 month, 1 year ) schedule_time Should be like 00:00:00 schedule_day schedule_day should be any one from (1, 2, 3, 4, 5, 6, 7) Weekdays from sunday to saturday. subject Campaign subject Required if list_id does not have default subject. Limit: 150 chars

Keep it relevant and non-spammy to avoid spam filters. content content_plain_text Required, if `campaign_type` = 2 (plain-text) track_opens, track_clicks, track_plain_text_clicks, google_analytics_link_t racking google_analytics_key, attachment File Accept only PDF/txt files /api/v1/autoresponder-update To update details of given autoresponder_id. api Your API key provided hash md5(your_login_email.api). MD5 of your email and api key provided autoresponder_id list_id Formet should be ( list_id_1:segment_id_1, list_id_1:segment_id_2, list_id_2:segment_id_3,..) event_id event_id should be any one from (1, 2, 3, 4) 1 - Subscription to list, 2 - Campaign is opened 3 - Any link in campaign is clicked, 4 - Specific link in campaign is clicked campaign_id / Required only when (event_id!= 1) specific_link_clicked / Required only when (event_id = 4)

autoresponder_send schedule_time / Should be like ( within the hour, 1 days, 1 week, 1 month, 1 year ) Should be like 00:00:00 schedule_day title schedule_day should be any one from (1, 2, 3, 4, 5, 6, 7) Weekdays from sunday to saturday. subject Campaign subject Required if list_id does not have default subject. Limit: 150 chars Keep it relevant and non-spammy to avoid spam filters. content content_plain_text Required, if `campaign_type` = 2 (plain-text) track_opens, track_clicks, track_plain_text_clicks, google_analytics_link_t racking, google_analytics_key attachment File Accept only PDF/txt files /api/v1/user-create To create user account. api Your API key provided hash Your HASH key provided first_name Enter the first name

last_name Enter the last name email Enter the email id Valid email domain Enter the domain name The domain may not be greater than 25 characters This is going to be the unique website address of your account password Enter the passsword Maximum size is 20 card_number Enter the card number Valid card number name_on_card Enter the name on card cvv Enter the card Cvv number Valid Cvv number Maximum size is 3 exp_year Enter the card expiry date (Ex:2015) exp_month Enter the card expiry month (Ex:01) address Enter the address city Enter the city state Enter the state country_code Enter the country code Valid country code zip_code Enter the zip code phone Enter the phone number Valid phone number coupon Enter the coupon code /api/v1/user-update To update user account. api Your API key provided hash Your HASH key provided user_id Enter the user id Valid user id first_name Enter the first name last_name Enter the last name old_password Enter the old password new_password Required, if old password exits confirmation_password Required, if old password exits and it is compare with new password phone Enter the phone number

/api/v1/opt-in-form To fetch opt in form api Your API key provided hash Your HASH key provided form_id Enter the form id Valid form id /api/v1/opt-in-create To create opt in form api Your API key provided hash Your HASH key provided list_id Should be like (1,2,3) form_name Enter the form name first_name Enter the first name caption last_name Enter the last name caption email Enter the email caption send_opt_mail To send confirmation mail(1-,0-) redirect_url To redirect thank you pagel /api/v1/subscriber-export To export Subscriber

api Your API key provided hash Your HASH key provided list_id List id start Starting Value of the Result (By default : 1) limit Result Limit Per Result (By default : 10) format Supported format CSV, text (By default : CSV)