Sendlane - API Reference

Transcription

1 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 from given lists /api/v1/send mail To delete 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

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

3 belongs to multiple list (listid_1, listid_2,...) Valid list_id Subscriber to delete. (Single ) Valid /api/v1/send-mail To send mails. api Your API key provided hash Your Hash provided sender_name Receiver's Name sender_ Receiver's Valid receipent_name Sting Sender Name receipent_ Sring Sender Valid cc_ Sting Carbon Copy Valid bcc_ Blind Carbon Copy Valid subject Sting Subject for the Mail reply_to_ Reply to Valid 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 is opened 1 - track; 0 - Will not track (0 - Default) track_clicks eger To track the links send in the 1- track; 0 -will not track (0 - Default) track_plain_text_clicks eger To track the links send in the 1- track; 0 -will not track (0 - Default)

4 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_ .api). MD5 of your 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_ Reply Yahoo/AOL reject s that claim to come from yahoo/aol but actually originate at non-yahoo/aol servers Valid default_reply_ Default Reply Yahoo/AOL reject s that claim to come from yahoo/aol but actually originate at non-yahoo/aol servers Valid subject Enter the subject short_reminder Enter the description company Enter the company name address Enter the Address city Enter the city

5 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_ .api). MD5 of your 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_ Reply Yahoo/AOL reject s that claim to come from yahoo/aol but actually originate at non-yahoo/aol servers Valid default_reply_ Default Reply Yahoo/AOL reject s that claim to come from yahoo/aol but actually originate at non-yahoo/aol servers Valid subject Enter the subject short_reminder Enter the description company Enter the company name

6 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_ .api). MD5 of your 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_ .api). MD5 of your and api key provided list_id eger Enter valid list id start eger Start limit from

7 limit eger End limit to /api/v1/autoresponders To fetch details of autoresponders. api Your API key provided hash md5(your_login_ .api). MD5 of your 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_ .api). MD5 of your 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,..)

8 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 s will come from. Use something they'll instantly recognize, like your company name. from_ Default reply-to of the list A verified address title Name of the campaign Replies to your campaign will go to this 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 )

9 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_ .api). MD5 of your 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

10 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_ .api). MD5 of your 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)

11 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

12 last_name Enter the last name Enter the id Valid 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

13 /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 Enter the caption send_opt_mail To send confirmation mail(1-,0-) redirect_url To redirect thank you pagel /api/v1/subscriber-export To export Subscriber

14 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)