Smartech

Suggest Edits

Introduction to Smartech API

 

Netcore Smartech offers comprehensive APIs that empower the Smartech users to make the most of the features and functionalities. Through APIs, you can manage your contacts, manage campaigns, download reports, track your contacts' activity, and perform many such day-to-day marketing tasks.

Here are some ways to use the APIs:

  • Synchronize data with CRM systems and databases: Instead of manually uploading files, automatically exchange information. For example, simultaneously move data from Web signup forms to both your CRM system and Smartech.
  • Online Subscription forms: Add a “Subscribe to Newsletter” option to your e-commerce checkout page. Through API integration, the contact data (as soon as he/she submits information), can be directly integrated into Smartech.
  • Targeted Broadcast: Pass historical contact behaviouaral data into Smartech through APIs. Create segments based on the data, and send targeted broadcasts.
  • Publishers’ data sync: Sync active subscription data into Smartech, so that only up to date accounts get your emails. Sync email activity with your customer database.
  • Behavioural Targeting: Link broadcast stats to your internal database for behavioural targeting.
  • Connect Smartech to a CMS, blog platform, e-commerce shopping cart, and more.
 
Suggest Edits

Getting Started with Smartech APIs

 

All Smartech APIs are based on REST architecture style. In these APIs, you need to initiate API key authenticated JSON calls over HTTPS.

To start using the APIs:

  • Enable API access in Smartech’s panel.
  • Submit a request via HTTPS POST to Smartech. For best results, use HTTPS POST.
  • Submit a call for each function. You cannot combine multiple calls into a single call. Each API request must include the following fields:
    • Module
    • Action
    • Data

These fields are case sensitive. Values for fields vary according to the type of request.

Module
The current Smartech API version comprises the following modules:

  • Broadcast
  • List
  • Activity

NOTE: In the API call, specify the module in the type field.

Action
Each module has various actions associated to it.
A few generic actions are:
• add
• delete
• update
• upload
• download

NOTE: In your API call, specify the action in the activity field.

Data
Data comprises the constant and the input. Constant: is the API key.
You can obtain the API key from the Smartech panel.
Log in to your Smartech panel and go to Admin.
Enable the API Mode in Account Configuration under Advance details.
Now, go to Sub Admin and click Edit on your user name.
You can view your API key here.
Input: comprises the raw parameters like listname, subject, from, and so on.

Smartech APIs supports the use of API keys. API Keys add an additional layer of security for your account. You can generate your API key from your Smartech panel.

Smartech provides libraries to help you quickly and easily integrate with the v2 APIs in 9 different languages: Shell, Go, Java, JavaScript, Node, Obj-C, PHP, Python, Ruby, Swift, C#, and C.

 
Suggest Edits

Add Contact

This API enables you to add a single contact to Smartech.

 
posthttp://api.netcoresmartech.com/version?type=type&activity=activity&apikey=apikey

Path Params

version
string
required
type
string
required

It represents the module or group the API belongs to. For example, if the API 's functionality is related to Contacts, type is 'contact'.

activity
string
required

Activity refers to the action that is being performed through the API, that is, add, delete, update, and so on.

apikey
string
required

It is panel api key

Body Params

data
string
required

Data is the input which comprises the raw parameters like listname, subject, from, and so on. For example: json format data e.g. { "NAME": "Mike", "EMAIL": "mike@google.com", "MOBILE":5654134, "AGE":24, "CITY":"Mumbai" } Here EMAIL is the primary key of contact.

listid
int32

Each list in Smartech has a unique ID assigned to it to identify. Passing this ID is required to let the API know to which list the contact is to be added.

 
curl --request POST \
  --url 'http://api.netcoresmartech.com/apiv2?apikey=apikey&activity=add&type=contact'
var request = require("request");

var options = { method: 'POST',
  url:
   'http://api.netcoresmartech.com/apiv2',
  qs:
   { apikey: 'apikey',
     activity: 'add',
     type: 'contact' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://api.netcoresmartech.com/apiv2?apikey=apikey&activity=add&type=contact")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://api.netcoresmartech.com/apiv2?apikey=apikey&activity=add&type=contact");

xhr.send(data);
import requests

url = "http://api.netcoresmartech.com/apiv2"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  Success
}
{
  Failed
}
 
Suggest Edits

View Contact Details

This API enables you to fetch and view the details of a contact.

 
gethttp://api.netcoresmartech.com/version?type=type&activity=activity&apikey=apikey

Path Params

version
string
required

Query Params

activity
string

Activity refers to the action that is being performed through the API, that is, add, delete, update, and so on.

type
string

It represents the module or group the API belongs to. For example, if the API 's functionality is related to Contacts, type is 'contact'.

apikey
string

It is the panel API key

data
string
required

Primary Key of the contact. e.g. example@netcore.com

 
curl --request GET \
  --url 'http://api.netcoresmartech.com/apiv2?data=data&apikey=apikey&activity=activity&type=type'
var request = require("request");

var options = { method: 'GET',
  url:
   'http://api.netcoresmartech.com/apiv2',
  qs:
   { data: 'data',
     apikey: 'apikey',
     activity: 'activity',
     type: 'type' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://api.netcoresmartech.com/apiv2?data=data&apikey=apikey&activity=activity&type=type")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://api.netcoresmartech.com/apiv2?data=data&apikey=apikey&activity=activity&type=type");

xhr.send(data);
import requests

url = "http://api.netcoresmartech.com/apiv2"

querystring = {"data":"data","apikey":"apikey","activity":"activity","type":"type"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated


{
  "Success"
}
{
Failed
}
 
Suggest Edits

Update Contact

This API enables you to update the details of a contact.

 
posthttp://api.netcoresmartech.com/version

Path Params

version
string
required

Query Params

apikey
string
required

You can obtain the API key from the Smartech panel. Log in to your Smartech panel and go to Admin. Enable the API Mode in Account Configuration under Advance details. Now, go to Sub Admin and click Edit on your user name. You can view your API key here.

type
string
required

It represents the module or group the API belongs to. For example, if the API 's functionality is related to Contacts, type is 'contact'.

activity
string
required

Activity refers to the action that is being performed through the API, that is, add, delete, update, and so on.

data
string
required

Data is the input which comprises the raw parameters like listname, subject, from, and so on.

 
curl --request POST \
  --url 'http://api.netcoresmartech.com/apiv2?apikey=apikey&type=contact&activity=update&data=data'
var request = require("request");

var options = { method: 'POST',
  url:
   'http://api.netcoresmartech.com/apiv2',
  qs:
   { apikey: 'apikey',
     type: 'contact',
     activity: 'update',
     data: 'data' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://api.netcoresmartech.com/apiv2?apikey=apikey&type=contact&activity=update&data=data")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://api.netcoresmartech.com/apiv2?apikey=apikey&type=contact&activity=update&data=data");

xhr.send(data);
import requests

url = "http://api.netcoresmartech.com/apiv2"

querystring = {"apikey":"apikey","type":"contact","activity":"update","data":"data"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available
 
Suggest Edits

Remove Contact

This API enables you to remove a contact from the List.

 
gethttp://api.netcoresmartech.com/version

Path Params

version
string
required

Query Params

apikey
string
required

Panel api key

type
string
required

It represents the module or group the API belongs to. For example, if the API 's functionality is related to Contacts, type is 'contact'.

activity
string
required

Activity refers to the action that is being performed through the API, that is, add, delete, update, and so on.

data
string
required

Data is the input which comprises the raw parameters like listname, subject, from, and so on. For example: json format data e.g. { "NAME": "Mike", "EMAIL": "mike@google.com", "MOBILE":5654134, "AGE":24, "CITY":"Mumbai" } Here, it is the primary key value of contact to be deleted.

listid
int32
required

Each list in Smartech has a unique ID assigned to it to identify. Passing this ID is required to let the API know to which list the contact is to be removed from. Single or multiple list IDs (comma separated) can be provided.

 
curl --request GET \
  --url 'http://api.netcoresmartech.com/apiv2?apikey=apikey&type=contact&activity=delete&data=data&listid=listid'
var request = require("request");

var options = { method: 'GET',
  url:
   'http://api.netcoresmartech.com/apiv2',
  qs:
   { apikey: 'apikey',
     type: 'contact',
     activity: 'delete',
     data: 'data',
     listid: 'listid' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://api.netcoresmartech.com/apiv2?apikey=apikey&type=contact&activity=delete&data=data&listid=listid")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://api.netcoresmartech.com/apiv2?apikey=apikey&type=contact&activity=delete&data=data&listid=listid");

xhr.send(data);
import requests

url = "http://api.netcoresmartech.com/apiv2"

querystring = {"apikey":"apikey","type":"contact","activity":"delete","data":"data","listid":"listid"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available
 
Suggest Edits

Add Bulk Contact

This API enables you to upload contacts to Smartech, in bulk.

 
posthttp://api.netcoresmartech.com/version

Path Params

version
string
required

Query Params

apikey
string
required

You can obtain the API key from the Smartech panel. Log in to your Smartech panel and go to Admin. Enable the API Mode in Account Configuration under Advance details. Now, go to Sub Admin and click Edit on your user name. You can view your API key here.

type
string
required

It represents the module or group the API belongs to. For example, if the API 's functionality is related to Contacts, type is 'contact'.

activity
string
required

Activity refers to the action that is being performed through the API, that is, add, delete, update, and so on.

path
string
required

This refers to the complete path of the hosted .csv file which contains the contact data.

listid
string

Each list in Smartech has a unique ID assigned to it to identify. Passing this ID is required to let the API know to which list the contact is to be added.

notifyemail
string

Once the bulk upload request is triggered, the upload process begins in the background. You may want to get notified when the upload is completed. This is the email ID to which the notification email is sent.

callback
string

This refers to the ping back URL to receive status of upload job.

 
curl --request POST \
  --url 'http://api.netcoresmartech.com/version?apikey=apikey&type=contact&activity=bulkupload&path=path'
var request = require("request");

var options = { method: 'POST',
  url: 'http://api.netcoresmartech.com/version',
  qs:
   { apikey: 'apikey',
     type: 'contact',
     activity: 'bulkupload',
     path: 'path' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://api.netcoresmartech.com/version?apikey=apikey&type=contact&activity=bulkupload&path=path")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://api.netcoresmartech.com/version?apikey=apikey&type=contact&activity=bulkupload&path=path");

xhr.send(data);
import requests

url = "http://api.netcoresmartech.com/version"

querystring = {"apikey":"apikey","type":"contact","activity":"bulkupload","path":"path"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available
 
Suggest Edits

Create List for Contact

Using this API, you can create a new list in Smartech.

 
posthttp://api.netcoresmartech.com/version

Path Params

version
string
required

Query Params

apikey
string
required

You can obtain the API key from the Smartech panel. Log in to your Smartech panel and go to Admin. Enable the API Mode in Account Configuration under Advance details. Now, go to Sub Admin and click Edit on your user name. You can view your API key here.

type
string
required

It represents the module or group the API belongs to. For example, if the API 's functionality is related to Lists, type is 'list'.

activity
string
required

Activity refers to the action that is being performed through the API, that is, add, delete, update, and so on.

listname
string
required

The name of the list that you are creating.

desc
string

Any description of the list that you may want to specify.

 
curl --request POST \
  --url 'http://api.netcoresmartech.com/apiv2?apikey=apikey&type=lists&activity=add&listname=listname'
var request = require("request");

var options = { method: 'POST',
  url:
   'http://api.netcoresmartech.com/apiv2',
  qs:
   { apikey: 'apikey',
     type: 'lists',
     activity: 'add',
     listname: 'listname' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://api.netcoresmartech.com/apiv2?apikey=apikey&type=lists&activity=add&listname=listname")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://api.netcoresmartech.com/apiv2?apikey=apikey&type=lists&activity=add&listname=listname");

xhr.send(data);
import requests

url = "http://api.netcoresmartech.com/apiv2"

querystring = {"apikey":"apikey","type":"lists","activity":"add","listname":"listname"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available
 
Suggest Edits

Rename Contact List

Using this API, you can rename an existing list.

 
posthttp://api.netcoresmartech.com/version

Path Params

version
string
required

Query Params

apikey
string
required

Panel api key

type
string
required
activity
string
required
listname
string
required

Provide list name

desc
string

Any description of the list that you may want to specify.

id
string
required

ID of the list to be renamed

 
curl --request POST \
  --url 'http://api.netcoresmartech.com/apiv2?apikey=apikey&type=lists&activity=edit&listname=listname&id=id'
var request = require("request");

var options = { method: 'POST',
  url:
   'http://api.netcoresmartech.com/apiv2',
  qs:
   { apikey: 'apikey',
     type: 'lists',
     activity: 'edit',
     listname: 'listname',
     id: 'id' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://api.netcoresmartech.com/apiv2?apikey=apikey&type=lists&activity=edit&listname=listname&id=id")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://api.netcoresmartech.com/apiv2?apikey=apikey&type=lists&activity=edit&listname=listname&id=id");

xhr.send(data);
import requests

url = "http://api.netcoresmartech.com/apiv2"

querystring = {"apikey":"apikey","type":"lists","activity":"edit","listname":"listname","id":"id"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available
 
Suggest Edits

Get all List

This API enables you to retreive all the lists that exist in your Smartech panel.

 
gethttp://api.netcoresmartech.com/version

Path Params

version
string
required

Query Params

apikey
string
required

You can obtain the API key from the Smartech panel. Log in to your Smartech panel and go to Admin. Enable the API Mode in Account Configuration under Advance details. Now, go to Sub Admin and click Edit on your user name. You can view your API key here.

type
string
required

It represents the module or group the API belongs to. For example, if the API 's functionality is related to Lists, type is 'list'.

activity
string
required

Activity refers to the action that is being performed through the API, that is, add, delete, update, and so on.

 
curl --request GET \
  --url 'http://api.netcoresmartech.com/apiv2?apikey=apikey&type=lists&activity=getall'
var request = require("request");

var options = { method: 'GET',
  url:
   'http://api.netcoresmartech.com/apiv2',
  qs:
   { apikey: 'apikey',
     type: 'lists',
     activity: 'getall' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://api.netcoresmartech.com/apiv2?apikey=apikey&type=lists&activity=getall")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://api.netcoresmartech.com/apiv2?apikey=apikey&type=lists&activity=getall");

xhr.send(data);
import requests

url = "http://api.netcoresmartech.com/apiv2"

querystring = {"apikey":"apikey","type":"lists","activity":"getall"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available
 
Suggest Edits

Delete List

This API enables you to delete a list. The contacts in the list are not deleted though.

 
posthttp://api.netcoresmartech.com/version

Path Params

version
string
required

Query Params

apikey
string
required

Panel API key

type
string
required

It represents the module or group the API belongs to. For example, if the API 's functionality is related to Lists, type is 'list'.

activity
string
required

Activity refers to the action that is being performed through the API, that is, add, delete, update, and so on.

listname
string
required

It refers to the name of the list that you want to delete.

 
curl --request POST \
  --url 'http://api.netcoresmartech.com/apiv2?apikey=apikey&type=lists&activity=delete&listname=listname'
var request = require("request");

var options = { method: 'POST',
  url:
   'http://api.netcoresmartech.com/apiv2',
  qs:
   { apikey: 'apikey',
     type: 'lists',
     activity: 'delete',
     listname: 'listname' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://api.netcoresmartech.com/apiv2?apikey=apikey&type=lists&activity=delete&listname=listname")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://api.netcoresmartech.com/apiv2?apikey=apikey&type=lists&activity=delete&listname=listname");

xhr.send(data);
import requests

url = "http://api.netcoresmartech.com/apiv2"

querystring = {"apikey":"apikey","type":"lists","activity":"delete","listname":"listname"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available
 
Suggest Edits

Add single Activity

This API enables you to sync your contact's activity data in real-time to Smartech. This API can be helpful in scenarios like:

● POS - The point of sale (POS) or point of purchase (POP) is the time and place where a retail transaction is completed.

● Call Centre data - Calls between customers and call center agents are brimming with information that, with the aid of speech analytics, can yield valuable insights that organizations can use to improve the customer experience.

● Offline store purchase - When you merge online and offline data, you can deliver the best possible experience to your customers.

● Historical Activity data - You can import historical activity data into your existing records.

 
posthttp://api.netcoresmartech.com/version/activity/singleactivity/EncryptedClientID

Path Params

version
string
required
EncryptedClientID
string
required

Contact Smartech to know EncryptedClient ID.

Body Params

activityid
string

When you define an activity in Smartech, the activity is assigned a unique ID for identification purpose. You need to pass that ID here.

cts
int32

This is the timestamp of the event in YYMMDDhhmmss format

uniqueid
string

This is the unique ID of the contact. This is mandatory if identity is not passed.

identity
string

This is the identifying information of the contact. It can be email/mobile/customerID of the logged in contact. This is same as the primary key in your Smartech Panel. Passing this parameter is mandatory for identified contacts.

activity_source
string

It is the source of the activity, that is - web, app, or custom. In other words, the contact may perform the activity on the web, or on the app, or in the physical world like store. So, this parameter represents the source of the activity.

activity_params
object

It is the set of parameters/payloads of the activity, which are predefined in Smartech panel as a part of the activity creation process. It is the JSON dictionary with keys having prefix for the datatypes: String - s^ Integer - i^ Float - f^ E.g.: {"s^name":"Nexus5","i^prid":10,"f^price":25000.00,"i^prqt":1}

activity_params.s_name
string
activity_params.i_prid
integer
activity_params.f_price
integer
activity_params.i_prqt
integer
 
{
  "actvityid": "nulla",
  "cts": 31590712,
  "uniqueid": "tempor incididunt anim Lorem",
  "identity": "Excepteur laborum id est amet",
  "activity_source": "sunt consequat Excepteur ve",
  "activity_params": {
    "s_name": "ea amet id aliquip",
    "i_prid": 38071038,
    "f_price": 28107361,
    "i_prqt": -46981173
  }
}
A binary file was returned

You couldn't be authenticated

No response examples available
 
Suggest Edits

Upload Contact and Publish Email Broadcast

 
posthttp://api.netcoresmartech.com//version

Path Params

version
string
required

apiv2

type
string
required

email_broadcast

activity
string
required

upload_ contact_and_publish

apikey
string
required

<Panel_API_Key>

Body Params

contacts_upload_source
string
required

Contact list (.csv or zip file with email IDs) path. Multiple contact list (.csv) can be compressed in the single zip file such that all the .csv files have the same header structure. The number of rows (including header) can be passed in the csv file name. E.g. FileName_5000.csv where 5000 is the number of rows. In such case set "check_rowcount" : 1 User can use “contacts_upload_source_file_md5” if user does not want to pass row count in the file name. Note: In case of .zip file, the row headers of all the .csv files should be similar. If the header has custom attributes which is not available in the string Required panel, then the API shall fail.

contacts_upload_source_fi le_md5
string

User can pass the number of rows of contact list through md5. Do not pass “check_rowcount” parameter when using md5

check_rowcount
string

If the user wishes to pass the number of rows of contact list in the a file name of the csv, then set “check_rowcount” : 1 Note: If check_rowcount is 1 then md5 parameter should not be passed

list_name
string
required

Name of the contact list. If the list name is already existing then api shall fail

campaign_name
string
required

Name of the email campaign

subject_line
string
required

Subject of the email

sender_name
string
required

Name of the sender

sender_email_id
string
required

Email ID of the sender

tags
string

Campaign labels/tags (max 5)

schedule_date
string
required

Date and time when the campaign should be published. Lead time for scheduling a campaign is 90 minutes. Format: “ YYYY-MM-DD HH:mm:SS ” Eg. "2018-03-31 15:00:00"

source_file
string
required

Email body HTML source file path. Optional if ‘source_code’ is used

source_code
string
required

should be pass as base64 encode. Optional if ‘source_file’ is used

notify_me
string
required

Email ID for API response. Multiple email id allowed.

 
data=
{
"list_name": "TestUpload1",
"campaign_name":"Test",
"subject_line":"TestBroad",
"sender_name": "sidd",
"sender_email_id": "sid@m3m.in",
"schedule_date": "2018-03-15 19:50:00",
"source_file":"http://www.peace.co.in/client_path/sid.html",
"notify_me":"sid.p@gmail.com",
"contacts_upload_source": "http://www.peace.co.in/client_path/batch_upload_12.csv",
"check_rowcount":"1"
}
A binary file was returned

You couldn't be authenticated

{
"RequestID" : "99999"
"success": true,
"CampaignID": "13123"
"message":
"payload": { /* ENTIRE PAYLOAD DATA COMES HERE */ }
}
{
"RequestID" : "99999"
"success": false,
"CampaignID":
"message": "Show Error message here"
"payload": { /* ENTIRE PAYLOAD DATA COMES HERE */ }
}