Mail

Send email campaign

Use this method to send emails to a group of contacts created through endpoint Create group method.

POSThttps://api.messageflow.com/v2.1/campaign/mail

Body

application/json

campaignIdstring

The unique ID of the campaign.

Example: "first-campaign-id"

Pattern: /^[a-zA-Z-_]+$/

name*string

The name of the campaign.

Example: "firstCampaign"

descriptionstring

The description of the campaign.

Example: "My first campaign"

subject*string

The subject of the message in the campaign.

Example: "Hello world"

fromName*string

The name of the sender.

Example: "John Doe"

fromAddress*string

The email address of the sender.

Example: "[e-mail]"

replyTostring

The email address to reply to.

Example: "[e-mail]"

htmlFromWebSiteUrl*string

The URL of the website.

htmlContent*string

The html of the message.

Example: "<h1> hello there</h1>"

textContentstring

The text of the message.

Example: "hello there!"

groupId*string

The externalId of the group the message will be sent to. This ID can be found using List group method.

Example: "test-group-id"

trackLinksboolean

The URL shortener and tracker. Setting this property to ‘true’ will make the urls shorter and also urls will be tracked.

Example: true

googleAnalyticsboolean

The optional campaign tracking parameter provided by Google Analytics.

Example: true

scheduleTimestring

The date the message will be set off. Be aware that if the campaign is going to be sent to many of recipients (thousands and more) the schedule date means then preparing all contacts firstly and then sending. For example, there is a campaign scheduled for 2020-01-01 10:00:00 so at 10 o'clock our system will start to collect all contacts from chosen group which can take sometimes more than an hour and then the messages will be sent to recipients.

Example: "2020-09-10 10:15:00"

Pattern: /^\d{4}-\d{2}-\d{2}\s*(?:\d{2}:\d{2}(?::\d{2})?)?$/

stateenum

If set to 'editable' allows to prevent sending email campaign immediately after creation

Example: "editable"

editablesendable

testAddresses*array of string

The email addresses to send the campaign to see if the message is ok.

confirmationAddressesarray of string

The email addresses to send info about campaign end.

Response

200207401404500

Request was successfully processed

Body

application/json

metaMetaObject (object)

Additional data

dataarray of object

Response

200207401404500

{
  "meta": {
    "numberOfErrors": 0,
    "numberOfData": 1,
    "status": 200,
    "uniqId": "00d928f759"
  },
  "data": [
    {
      "externalId": "text"
    }
  ]
}

C#

var client = new RestClient("https://api.messageflow.com/v2.1/campaign/mail");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"campaignId\":\"first-campaign-id\",\"name\":\"firstCampaign\",\"description\":\"My first campaign\",\"subject\":\"Hello world\",\"fromName\":\"John Doe\",\"fromAddress\":\"[e-mail]\",\"replyTo\":\"[e-mail]\",\"htmlFromWebSiteUrl\":\"string\",\"htmlContent\":\"<h1> hello there</h1>\",\"textContent\":\"hello there!\",\"groupId\":\"test-group-id\",\"trackLinks\":true,\"googleAnalytics\":true,\"scheduleTime\":\"2020-09-10 10:15:00\",\"state\":\"editable\",\"testAddresses\":[\"[e-mail]\"],\"confirmationAddresses\":[\"[e-mail]\"]}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Go

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.messageflow.com/v2.1/campaign/mail"

	payload := strings.NewReader("{\"campaignId\":\"first-campaign-id\",\"name\":\"firstCampaign\",\"description\":\"My first campaign\",\"subject\":\"Hello world\",\"fromName\":\"John Doe\",\"fromAddress\":\"[e-mail]\",\"replyTo\":\"[e-mail]\",\"htmlFromWebSiteUrl\":\"string\",\"htmlContent\":\"<h1> hello there</h1>\",\"textContent\":\"hello there!\",\"groupId\":\"test-group-id\",\"trackLinks\":true,\"googleAnalytics\":true,\"scheduleTime\":\"2020-09-10 10:15:00\",\"state\":\"editable\",\"testAddresses\":[\"[e-mail]\"],\"confirmationAddresses\":[\"[e-mail]\"]}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "REPLACE_KEY_VALUE")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Java

HttpResponse<String> response = Unirest.post("https://api.messageflow.com/v2.1/campaign/mail")
  .header("content-type", "application/json")
  .header("authorization", "REPLACE_KEY_VALUE")
  .body("{\"campaignId\":\"first-campaign-id\",\"name\":\"firstCampaign\",\"description\":\"My first campaign\",\"subject\":\"Hello world\",\"fromName\":\"John Doe\",\"fromAddress\":\"[e-mail]\",\"replyTo\":\"[e-mail]\",\"htmlFromWebSiteUrl\":\"string\",\"htmlContent\":\"<h1> hello there</h1>\",\"textContent\":\"hello there!\",\"groupId\":\"test-group-id\",\"trackLinks\":true,\"googleAnalytics\":true,\"scheduleTime\":\"2020-09-10 10:15:00\",\"state\":\"editable\",\"testAddresses\":[\"[e-mail]\"],\"confirmationAddresses\":[\"[e-mail]\"]}")
  .asString();

Node

var request = require("request");

var options = {
  method: 'POST',
  url: 'https://api.messageflow.com/v2.1/campaign/mail',
  headers: {'content-type': 'application/json', authorization: 'REPLACE_KEY_VALUE'},
  body: {
    campaignId: 'first-campaign-id',
    name: 'firstCampaign',
    description: 'My first campaign',
    subject: 'Hello world',
    fromName: 'John Doe',
    fromAddress: '[e-mail]',
    replyTo: '[e-mail]',
    htmlFromWebSiteUrl: 'string',
    htmlContent: '<h1> hello there</h1>',
    textContent: 'hello there!',
    groupId: 'test-group-id',
    trackLinks: true,
    googleAnalytics: true,
    scheduleTime: '2020-09-10 10:15:00',
    state: 'editable',
    testAddresses: ['[e-mail]'],
    confirmationAddresses: ['[e-mail]']
  },
  json: true
};

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

  console.log(body);
});

Php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.messageflow.com/v2.1/campaign/mail",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"campaignId\":\"first-campaign-id\",\"name\":\"firstCampaign\",\"description\":\"My first campaign\",\"subject\":\"Hello world\",\"fromName\":\"John Doe\",\"fromAddress\":\"[e-mail]\",\"replyTo\":\"[e-mail]\",\"htmlFromWebSiteUrl\":\"string\",\"htmlContent\":\"<h1> hello there</h1>\",\"textContent\":\"hello there!\",\"groupId\":\"test-group-id\",\"trackLinks\":true,\"googleAnalytics\":true,\"scheduleTime\":\"2020-09-10 10:15:00\",\"state\":\"editable\",\"testAddresses\":[\"[e-mail]\"],\"confirmationAddresses\":[\"[e-mail]\"]}",
  CURLOPT_HTTPHEADER => array(
    "authorization: REPLACE_KEY_VALUE",
    "content-type: application/json"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Python

import requests

url = "https://api.messageflow.com/v2.1/campaign/mail"

payload = "{\"campaignId\":\"first-campaign-id\",\"name\":\"firstCampaign\",\"description\":\"My first campaign\",\"subject\":\"Hello world\",\"fromName\":\"John Doe\",\"fromAddress\":\"[e-mail]\",\"replyTo\":\"[e-mail]\",\"htmlFromWebSiteUrl\":\"string\",\"htmlContent\":\"<h1> hello there</h1>\",\"textContent\":\"hello there!\",\"groupId\":\"test-group-id\",\"trackLinks\":true,\"googleAnalytics\":true,\"scheduleTime\":\"2020-09-10 10:15:00\",\"state\":\"editable\",\"testAddresses\":[\"[e-mail]\"],\"confirmationAddresses\":[\"[e-mail]\"]}"
headers = {
    'content-type': "application/json",
    'authorization': "REPLACE_KEY_VALUE"
    }

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.messageflow.com/v2.1/campaign/mail")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request["authorization"] = 'REPLACE_KEY_VALUE'
request.body = "{\"campaignId\":\"first-campaign-id\",\"name\":\"firstCampaign\",\"description\":\"My first campaign\",\"subject\":\"Hello world\",\"fromName\":\"John Doe\",\"fromAddress\":\"[e-mail]\",\"replyTo\":\"[e-mail]\",\"htmlFromWebSiteUrl\":\"string\",\"htmlContent\":\"<h1> hello there</h1>\",\"textContent\":\"hello there!\",\"groupId\":\"test-group-id\",\"trackLinks\":true,\"googleAnalytics\":true,\"scheduleTime\":\"2020-09-10 10:15:00\",\"state\":\"editable\",\"testAddresses\":[\"[e-mail]\"],\"confirmationAddresses\":[\"[e-mail]\"]}"

response = http.request(request)
puts response.read_body

Shell

echo '{"campaignId":"first-campaign-id","name":"firstCampaign","description":"My first campaign","subject":"Hello world","fromName":"John Doe","fromAddress":"[e-mail]","replyTo":"[e-mail]","htmlFromWebSiteUrl":"string","htmlContent":"<h1> hello there</h1>","textContent":"hello there!","groupId":"test-group-id","trackLinks":true,"googleAnalytics":true,"scheduleTime":"2020-09-10 10:15:00","state":"editable","testAddresses":["[e-mail]"],"confirmationAddresses":["[e-mail]"]}' |  \
  http POST https://api.messageflow.com/v2.1/campaign/mail \
  authorization:REPLACE_KEY_VALUE \
  content-type:application/jsonrmationAddresses":["[e-mail]"]}'

Change email campaign state

Use this method if you want to change the status of an already prepared or launched campaign. You can only start or cancel campaign. Each campaign gets statuses like editing, redytosend, sending and sent. If you cancel campaign that have sending state it will get sent state.

PATCHhttps://api.messageflow.com/v2.1/campaign/mail/{campaignId}

Path parameters

campaignId*string

Id of existing campaign

Body

application/json

stateenum

sendablecanceled

scheduleTimestring

The date the message will be set off. Be aware that if the campaign is going to be sent to many of recipients (thousands and more) the schedule date means then preparing all contacts firstly and then sending. For example, there is a campaign scheduled for 2020-01-01 10:00:00 so at 10 o'clock our system will start to collect all contacts from chosen group which can take sometimes more than an hour and then the messages will be sent to recipients.

Example: "2020-09-10 10:15:00"

Pattern: /^\d{4}-\d{2}-\d{2}\s*(?:\d{2}:\d{2}(?::\d{2})?)?$/

testAddressesarray of string

The email addresses to send the campaign to see if the message is ok.

Response

200401404500

Request was successfully processed

Body

application/json

metaMetaObject (object)

Additional data

Response

200401404500

{
  "meta": {
    "numberOfErrors": 0,
    "numberOfData": 1,
    "status": 200,
    "uniqId": "00d928f759"
  }
}

C#

var client = new RestClient("https://api.messageflow.com/v2.1/campaign/mail/%7BcampaignId%7D");
var request = new RestRequest(Method.PATCH);
request.AddHeader("content-type", "application/json");
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"state\":\"sendable\",\"scheduleTime\":\"2020-09-10 10:15:00\",\"testAddresses\":[\"[e-mail]\"]}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Go

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.messageflow.com/v2.1/campaign/mail/%7BcampaignId%7D"

	payload := strings.NewReader("{\"state\":\"sendable\",\"scheduleTime\":\"2020-09-10 10:15:00\",\"testAddresses\":[\"[e-mail]\"]}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "REPLACE_KEY_VALUE")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Java

HttpResponse<String> response = Unirest.patch("https://api.messageflow.com/v2.1/campaign/mail/%7BcampaignId%7D")
  .header("content-type", "application/json")
  .header("authorization", "REPLACE_KEY_VALUE")
  .body("{\"state\":\"sendable\",\"scheduleTime\":\"2020-09-10 10:15:00\",\"testAddresses\":[\"[e-mail]\"]}")
  .asString();

Node

var request = require("request");

var options = {
  method: 'PATCH',
  url: 'https://api.messageflow.com/v2.1/campaign/mail/%7BcampaignId%7D',
  headers: {'content-type': 'application/json', authorization: 'REPLACE_KEY_VALUE'},
  body: {
    state: 'sendable',
    scheduleTime: '2020-09-10 10:15:00',
    testAddresses: ['[e-mail]']
  },
  json: true
};

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

  console.log(body);
});

Php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.messageflow.com/v2.1/campaign/mail/%7BcampaignId%7D",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => "{\"state\":\"sendable\",\"scheduleTime\":\"2020-09-10 10:15:00\",\"testAddresses\":[\"[e-mail]\"]}",
  CURLOPT_HTTPHEADER => array(
    "authorization: REPLACE_KEY_VALUE",
    "content-type: application/json"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Python

import requests

url = "https://api.messageflow.com/v2.1/campaign/mail/%7BcampaignId%7D"

payload = "{\"state\":\"sendable\",\"scheduleTime\":\"2020-09-10 10:15:00\",\"testAddresses\":[\"[e-mail]\"]}"
headers = {
    'content-type': "application/json",
    'authorization': "REPLACE_KEY_VALUE"
    }

response = requests.request("PATCH", url, data=payload, headers=headers)

print(response.text)

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.messageflow.com/v2.1/campaign/mail/%7BcampaignId%7D")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request["authorization"] = 'REPLACE_KEY_VALUE'
request.body = "{\"state\":\"sendable\",\"scheduleTime\":\"2020-09-10 10:15:00\",\"testAddresses\":[\"[e-mail]\"]}"

response = http.request(request)
puts response.read_body

Shell

echo '{"state":"sendable","scheduleTime":"2020-09-10 10:15:00","testAddresses":["[e-mail]"]}' |  \
  http PATCH https://api.messageflow.com/v2.1/campaign/mail/%7BcampaignId%7D \
  authorization:REPLACE_KEY_VALUE \
  content-type:application/json","testAddresses":["[e-mail]"]}'