Email Campaign API

Netcore’s Email Campaign API will be an easy non-UI dependent way to create Email campaigns. This document will help you with the details of the API signature that we are planning.

Quick summary of what you can do with this Email campaign API :

• You can call this API when you want to create a broadcast email campaign.
• Define campaign parameters directly in the requests such as campaign details, audience details, email template details, scheduling conditions.
• You get an option to schedule it directly for execution as well.

API details:

API endpoint -
US : https://api.netcoresmartech.com/apiv2?activity=upload_contact_and_publish
IND: https://apiin.netcoresmartech.com/apiv2?activity=upload_contact_and_publish
EU : https://goapiv3.eu-north-1.eu.netcoresmartech.com/apiv2?activity=upload_contact_and_publish

Method -
POST

Content-Type -
application/json

Sample Request for the Body

Using List ID, Template ID, Suppression List from panel

{
  "campaign_name": "Campaign API Test1",
  "subject_line": "Campaign API Test-1",
  "sender_email_id": "[email protected]",
  "replyto": "[email protected]",
  "sender_name": "Netcore",
  "schedule_date": "now",                       
  "templateid": "17",       
  "target_lists": "151",
  "suppression_list":"153",
  "tags":"abc,test_tag",
  "notify_me": "[email protected]"
}

Using List ID, Suppression List from panel & Hosted HTML template from API

{
  "campaign_name": "Campaign API Test2",
  "subject_line": "Happy Diwali [NAME] 😊",
  "sender_email_id": "[email protected]",
  "replyto": "[email protected]",
  "sender_name": "Netcore",
  "schedule_date": "now",
  "source_file": "http://smtreports.netcore.co.in/jobs/mtemplate.html",
  "target_lists": "151",
  "suppression_list":"153",
  "tags":"abc,test_tag",
  "notify_me": "[email protected]"
}

Using Upload CSV & Hosted HTML template from API

{
  "campaign_name": "Campaign API Test - 3",
  "subject_line": "Hey [NAME], how are you?",
  "sender_email_id": "[email protected]",
  "replyto": "[email protected]",
  "sender_name": "Netcore",
  "schedule_date": "2020-11-12 18:15:00",
  "source_file": "http://smtreports.netcore.co.in/jobs/mtemplate.html",
  "contacts_upload_source": "http://smtreports.netcore.co.in/jobs/mylist_3.csv",
  "check_rowcount": "1",
  "list_name": "Emailapitest1",
  "tags":"abc,test_tag",
  "notify_me": "[email protected]"
}

Using Template ID from panel, Upload CSV from API

{
  "campaign_name": "Campaign API Test - 4",
  "subject_line": "”Happy Diwali” [NAME]",
  "sender_email_id": "[email protected]",
  "replyto": "[email protected]",
  "sender_name": "Netcore",
  "schedule_date": "2020-11-12 18:30:00",
  "templateid": "17",
  "contacts_upload_source": "http://smtreports.netcore.co.in/jobs/mylist_3.csv",
  "check_rowcount": "1",
  "list_name": "Emailapitest",
  "tags":"abc,test_tag",
  "notify_me": "[email protected]"
}

API Body Payload Details:

API Response code and description: