Sendlane - API Reference

(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/listsubscribersadd To add Multiple subscribers with single list. ● /api/v1/subscribersdelete To delete email from given lists ● /api/v1/sendmail To delete email from given lists ● /api/v1/listcreate To create list ● /api/v1/listupdate To update list ● /api/v1/listdelete To delete list ● /api/v1/lists To get lists ● /api/v1/autoresponders To fetch autoresponders ● /api/v1/autorespondercreate To create autoresponders ● /api/v1/autoresponderconfirm To confirm autoresponder ● /api/v1/autoresponderupdate To confirm autoresponder ● /api/v1/usercreate To create user account ● /api/v1/userupdate To update user account ● /api/v1/optinform To fetch optin form ● /api/v1/optincreate To create optin form ● /api/v1/subscriberexport To export subscriber

(2)

/api/v1/list-subscribers-add

To add Multiple subscribers with single list.

Parameters Required Type Description

api Yes String Your API key provided

hash Yes String md5(your_login_email.api). MD5 of your email and api key provided

email Yes String Email format should be like the following and separated by comma

firstname lastname<[email protected]>,firstname lastname<[email protected]>

or

firstname<[email protected]>,firstname<[email protected] om> or <[email protected]>, <[email protected]> or [email protected], [email protected] Valid email

list_id Yes Int Valid list_id

/api/v1/subscribers-delete

To delete subscriber from given lists.

(3)

email belongs to multiple list (listId_1, listId_2,...)

Valid list_id

email Yes String Subscriber email to delete. (Single email)

Valid email

/api/v1/send-mail

To send mails.

hash Yes String Your Hash provided

sender_name No String Receiver's Name

sender_email Yes String Receiver's email Valid email

receipent_name No Sting Sender Name

receipent_email Yes Sring Sender email Valid email

cc_email No Sting Carbon Copy Email Valid email

bcc_email No String Blind Carbon Copy Email Valid email

subject No Sting Subject for the Mail

reply_to_email No String Reply to email Valid email

content_html Yes String Body of the message (Html tags allowed)

content_plain_text No String Body Of the message in plain (No Html Tags) (Yes, if content_html not exists)

track_opens No Integer To track email is opened

1 - track; 0 - Will not track (0 - Default) track_clicks No Integer To track the links send in the email

1- track; 0 -will not track (0 - Default) track_plain_text_clicks No Integer To track the links send in the email

(4)

track_google_analytics_lin k

No Integer 1- track; 0 -will not track (0 - Default) google_analytics_key No String Empty By Default

/api/v1/list-create

To create list.

hash Yes String md5(your_login_email.api). MD5 of your email

and api key provided

list_name Yes String List name will be unique and it will be not allow duplicate list names

from_name reply_email default_reply_email subject short_reminder company address city Yes Yes No No Yes Yes Yes Yes String String String String String String String String

From name may not be greater than 100 characters it will not allow regular expressions like "/^[^\"<>@]+$/"

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 Yahoo/AOL reject emails that claim to come from yahoo/AOL but actually originate at non-Yahoo/AOL servers Valid email

Enter the subject Enter the description Enter the company name Enter the Address

(5)

zipcode country state phone Yes Yes Yes Yes String String String Integer

Enter the zipcode Enter the country Enter the state

Enter phone number Valid phone

/api/v1/list-update

To update list.

list_id Yes Integer Enter valid list id

from_name reply_email default_reply_email subject short_reminder company No No No No No No String String String String String String

From name may not be greater than 100 characters it will not allow regular expressions like "/^[^\"<>@]+$/"

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 Yahoo/AOL reject emails that claim to come from yahoo/AOL but actually originate at non-Yahoo/AOL servers

Valid email

Enter the subject Enter the description Enter the company name

(6)

address city zipcode country state phone No No No No No No String String String String String Integer

Enter the Address Enter the city Enter the zipcode Enter the country Enter the state

Enter phone number Valid phone

/api/v1/list-delete

To delete list.

list_id Yes Integer Enter valid list id

/api/v1/lists

To get lists.

and api key provided list_id start No No Integer Integer

Enter valid list id Start limit from

(7)

limit No Integer End limit to

/api/v1/autoresponders

To fetch details of autoresponders.

hash Yes String md5(your_login_email.api). MD5 of your email and

api key provided autoresponder_id

autoresponder_type

No No

Int

Int 1 - Regular, 2 - Plain-text.

title No String

list_id No Int list_id should be valid and exists.

status No String 'NotStarted', 'Progressing', 'Cancelled', 'Completed', 'Draft', 'Deleted', 'Scheduled', 'Stop'. Choose any one.

start No Int Record start from page.

lmiit No Int Total records you want to fetch.

/api/v1/autoresponder-create

To create a new autoresponder.

hash Yes String md5(your_login_email.api). MD5 of your email and

api key provided

autoresponder_type Yes Int Regular or Plain-text. Choose any one list_id Yes String Format should be ( list_id_1:segment_id_1,

(8)

event_id campaign_id specific_link_clicked autoresponder_send schedule_time schedule_day Yes No/Yes No/Yes No No No Int Int String String String String

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 Required only when (event_id != 1) Required only when (event_id = 4)

Should be like (‘within the hour’, ‘1 days’, ‘1 week’, ‘1 month’, ‘1 year’ )

Should be like ‘00:00:00’

schedule_day should be any one from (1, 2, 3, 4, 5, 6, 7) ‘ Weekdays from sunday to saturday’.

subject No String Campaign subject.

Required if list_id does not have default subject. Limit: 150 chars

Keep it relevant and non-spammy to avoid spam filters.

from_name No String Limit: 100 chars

Special chars " < > @ not allowed

This is who your emails will come from. Use something they'll instantly recognize, like your company name.

from_email No String Default reply-to email of the list

A verified email address

Replies to your campaign will go to this email address.

title No String Name of the campaign

content Yes String HTML Content of the campaign

content_plain_text No String Required, if `campaign_type` = 2 (plain-text)

Plain-text content of the campaign google_analytics_link_t

racking

(9)

google_analytics_key No String

track_opens No String ‘Yes’, ‘No’ (by default ‘No’) track_clicks No String ‘Yes’, ‘No’ (by default ‘No’) track_plain_text_clicks No String ‘Yes’, ‘No’ (by default ‘No’)

attachment File Accept only PDF//txt files

/api/v1/autoresponder-confirm

To confirm autoresponder.

autoresponder_id Yes Int

autoresponder_type No String Regular or Plain-text. Choose any one

event_id campaign_id specific_link_clicked autoresponder_send schedule_time schedule_day Yes No/Yes No/Yes Yes No No Int Int String String String String

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 Required only when (event_id != 1) Required only when (event_id != 4)

subject No String Campaign subject

(10)

content No String

track_opens No String ‘Yes’, ‘No’

track_clicks No String ‘Yes’, ‘No’

track_plain_text_clicks No String ‘Yes’, ‘No’ google_analytics_link_t

racking

No String ‘Yes’, ‘No’ google_analytics_key

attachment

No String

File Accept only PDF/txt files

/api/v1/autoresponder-update

To update details of given autoresponder_id.

autoresponder_id Yes Int

list_id No String Formet should be ( list_id_1:segment_id_1,

list_id_1:segment_id_2, list_id_2:segment_id_3,..) event_id campaign_id specific_link_clicked Yes No/Yes No/Yes Int Int Int

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

Required only when (event_id != 1) Required only when (event_id = 4)

(11)

autoresponder_send schedule_time schedule_day title No/Yes Yes No No String String String String

subject No String Campaign subject

content No String

track_opens No String ‘Yes’, ‘No’

track_clicks No String ‘Yes’, ‘No’

track_plain_text_clicks No String ‘Yes’, ‘No’ google_analytics_link_t

racking

No String ‘Yes’, ‘No’ google_analytics_key

attachment

No String

File Accept only PDF/txt files

/api/v1/user-create

To create user account.

hash first_name Yes Yes String String

Your HASH key provided Enter the first name

(12)

last_name email domain Yes Yes Yes String String String

Enter the last name

Enter the email id Valid email

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 Yes String Enter the passsword Maximum size is 20

card_number Yes Int Enter the card number Valid card number

name_on_card Yes String Enter the name on card

cvv Yes Int Enter the card Cvv number Valid Cvv number

Maximum size is 3

exp_year Yes Int Enter the card expiry date (Ex:2015) exp_month Yes Int Enter the card expiry month (Ex:01) address Yes String Enter the address

city Yes String Enter the city state Yes String Enter the state

country_code Yes String Enter the country code Valid country code

zip_code Yes String Enter the zip code

phone Yes Int Enter the phone number Valid phone number

coupon No String Enter the coupon code

/api/v1/user-update

To update user account.

hash user_id first_name last_name old_password new_password confirmation_password phone Yes Yes No No No Yes Yes No String String String String String String String String

Your HASH key provided Enter the user id Valid user id

Enter the first name Enter the last name Enter the old password

Required, if old password exits

Required, if old password exits and it is compare with new password

(13)

/api/v1/opt-in-form

To fetch opt in form

hash Yes String Your HASH key provided form_id Yes Int Enter the form id Valid form id

/api/v1/opt-in-create

To create opt in form

hash Yes String Your HASH key provided list_id Yes String Should be like (1,2,3) form_name Yes String Enter the form name first_name No String Enter the first name caption last_name No String Enter the last name caption email Yes String Enter the email caption

send_opt_mail No Int To send confirmation mail(1-Yes,0-No) redirect_url No String To redirect thank you pagel

/api/v1/subscriber-export

To export Subscriber

(14)

hash Yes String Your HASH key provided

list_id Yes Int List id

start No Int Starting Value of the Result (By default : 1)

limit No Int Result Limit Per Result (By default : 10)

format No String Supported format CSV , text (By default : CSV)