API Docs

This is Sendlane’s API Documentation, which contains a full index of Sendlane’s API calls and how to implement them. 

The sections here will go over getting started, the full list of API calls and details for each call individually. 

Getting Started All calls should be made using the POST method. Every call must include an API Key and Hash Key, which is unique to each Sendlane user account. 

The api/v1/user-details call can be used with your email log-in and password passed through to obtain your API & Hash keys. This is the only call that does not require your API and Hash keys. 

The API and Hash keys are also accessible in your Account Settings under Developer. All responses to our API calls are shown in JSON with the exception of api/v1/subscriber-export which is returned as a serialized string. 

Many of the methods listed below will have example responses. Each call will require the API / Hash keys to be passed in along with other parameters that are specific to each method. 

Please see below for more detail for each available call.

General example API call:

https://SUBDOMAIN.sendlane.com/api/v1/METHOD?api=APIKEY&hash=HASHKEY

List of API Calls – To get the api and hash key of the user.

• /api/v1/user-details

– To add Multiple subscribers with single list without custom fields.

• /api/v1/list-subscribers-add

– To add a Single subscriber to a list with custom fields.

• /api/v1/list-subscriber-add

– To delete email from given lists

• /api/v1/subscribers-delete

– To unsubscribe an email address

• /api/v1/unsubscribe

– To create list

• /api/v1/list-create

– To update list

• /api/v1/list-update

– To delete list

• /api/v1/list-delete

– To get lists

• /api/v1/lists

– To fetch optin form

• /api/v1/opt-in-form

– To create optin form

• /api/v1/opt-in-create

– To export subscriber

• /api/v1/subscriber-export

– To get the list of tags

• /api/v1/tags

– To create a new Tag

• /api/v1/tag-create

– To add a single existing subscriber to tags.

• /api/v1/tag-subscriber-add

– To remove a single existing subscriber to tags

• /api/v1/tag-subscriber-remove

– To return subscriber record for an existing contact.

• /api/v1/subscriber-exists

/api/v1/user-details To get the api and hash key of the user Example API call:

<code>https://<a href="https://help.sendlane.com/wp-content/uploads/2015/11/Subdomain_DS.png">SUBDOMAIN</a>.sendlane.com/api/v1/user-details ?email=<a>EMAILID</a> &password=<a>PASSWORD</a>

Successful call: /api/v1/list-subscribers-add To add Multiple subscribers with single list without custom fields. Example API call:

<code>https://SUBDOMAIN.sendlane.com/api/v1/list-subscribers-add ?api=APIKEY &hash=HASHKEY      // default params &list_id=VALIDLISTID &email=<a>VALIDEMAIL1</a>,<a>VALIDEMAIL2</a>,<a>VALIDEMAIL3</a>...     // method specific params

Successful call: /api/v1/list-subscriber-add To add a Single subscriber to a list with custom fields Example API call:

<code>https://SUBDOMAIN.sendlane.com/api/v1/list-subscriber-add ?api=APIKEY &hash=HASHKEY     // default params &list_id=VALIDLISTID &email=<a>VALIDEMAIL1</a>     // method specific params

Successful call: /api/v1/subscribers-delete To delete subscriber from given lists. Example API call:

<code>https://SUBDOMAIN.sendlane.com/api/v1/subscribers-delete ?api=APIKEY &hash=HASHKEY      // default params &list_id=VALIDLISTID &email=<a>EXISTINGSUBSCRIBER</a>     // method specific params

Successful call: /api/v1/unsubscribe To unsubscribe an email address. Example API call:

<code>https://SUBDOMAIN.sendlane.com/api/v1/unsubscribe ?api=APIKEY &hash=HASHKEY      // default params &list_id=VALIDLISTID &email=<a>EXISTINGSUBSCRIBER</a>     // method specific params

Successful call:

<code>"success": "Unsubscribed successfully."

/api/v1/list-create To create list. xample API call:

<code>https://SUBDOMAIN.sendlane.com/api/v1/list-create ?api=APIKEY &hash=HASHKEY     // default params &list_name=<a>LISTNAME</a> &from_name=<a>FROMNAME</a> &reply_email=<a>DEFAULTFROMEMAIL</a> <a href="http://blog.sendlane.com/important-announcement/">(custom email domain)</a> &short_reminder=<a>SHORTDESCRIPTION</a> &company=<a>COMPANYNAME</a> &address=<a>ADDRESS</a> &city=<a>CITY</a> &zipcode=<a>ZIPCODE</a> &state=<a>STATE</a> &country=<a>COUNTRY</a> &phone=<a>PHONE#</a>     // method specific params

Successful call:

/api/v1/list-update To update list. Example API call:

<code>https://SUBDOMAIN.sendlane.com/api/v1/list-update ?api=APIKEY &hash=HASHKEY     // default params &list_id=VALIDLISTID & parameters to be updated     // method specific params

Successful call: 

/api/v1/list-delete To delete list. Example API call:

<code>https://SUBDOMAIN.sendlane.com/api/v1/list-delete ?api=APIKEY &hash=HASHKEY     // default params &list_id=VALIDLISTID     // method specific params

Successful call:

/api/v1/lists To get lists. Example API call:

<code>https://SUBDOMAIN.sendlane.com/api/v1/lists ?api=APIKEY &hash=HASHKEY

Successful call:

/api/v1/opt-in-form To fetch opt in form Example API call:

<code>https://SUBDOMAIN.sendlane.com/api/v1/opt-in-form ?api=APIKEY &hash=HASHKEY     // default params &form_id=<a>VALIDFORMID</a>     // method specific params

Successful call:

/api/v1/opt-in-create To create opt in form Example API call:

<code>https://SUBDOMAIN.sendlane.com/api/v1/opt-in-create ?api=APIKEY &hash=HASHKEY     // default params &list_id=<VALIDLISTID &form_name=<a>FORMNAME</a> &email=<a>CAPTION</a>     // method specific params

Successful call:

/api/v1/subscriber-export To export Subscriber Example API call:

<code>https://SUBDOMAIN.sendlane.com/api/v1/subscriber-export ?api=APIKEY &hash=HASHKEY     // default params &list_id=VALIDLISTID     // method specific params

Successful call: 

<code>a:1: {s:8:"response";s:301:     "Email,FirstName,LastName,"custom field 1","Subscribed date",subscribed     VALIDEMAIL,FIRSTNAME,LASTNAME,CUSTOMFIELD,"##-##-#### ##:##:##",Yes     VALIDEMAIL,FIRSTNAME,LASTNAME,CUSTOMFIELD,"##-##-#### ##:##:##",Yes     VALIDEMAIL,FIRSTNAME,LASTNAME,CUSTOMFIELD,"##-##-#### ##:##:##",Yes     VALIDEMAIL,FIRSTNAME,LASTNAME,CUSTOMFIELD,"##-##-#### ##:##:##",Yes     VALIDEMAIL,FIRSTNAME,LASTNAME,CUSTOMFIELD,"##-##-#### ##:##:##",Yes ";}

/api/v1/tags To get the list of tags. Example API call:

<code>https://SUBDOMAIN.sendlane.com/api/v1/tags ?api=APIKEY &hash=HASHKEY     // default params

Successful call:

/api/v1/tag-create To create a new Tag. Example API call:

<code>https://SUBDOMAIN.sendlane.com/api/v1/tag-create ?api=APIKEY &hash=HASHKEY     // default params &name=<a>TAGNAME</a>     // method specific params

Successful call:

 /api/v1/tag-subscriber-add To add a tag to a single existing subscriber. Example API call:

<code>https://SUBDOMAIN.sendlane.com/api/v1/tag-subscriber-add ?api=APIKEY &hash=HASHKEY     // default params &email=<a>VALIDSUBSCRIBEREMAIL</a> &tag_ids=VALIDTAGID     // method specific params

Successful call:

/api/v1/tag-subscriber-remove To remove a single existing subscriber’s tag. Example API call:

<code>https://SUBDOMAIN.sendlane.com/api/v1/tag-subscriber-remove ?api=APIKEY &hash=HASHKEY     // default params &email=<a>VALIDSUBSCRIBEREMAIL</a> &tag_ids=VALIDTAGID     // method specific params

Successful call: 

/api/v1/subscriber-exists To return subscriber record for an existing contact.

Example API call:

<code>https://SUBDOMAIN.sendlane.com/api/v1/subscriber-exists<br>?api=APIKEY<br>&hash=HASHKEY     // default params<br>&list_id=VALIDLISTID<br>&email=VALIDEMAIL     // method specific params

Successful call: