Template

Get template list

Use this method to list all created email templates.

GEThttps://api.messageflow.com/v2.1/email/template

Query parameters

Response

200401404500

Request was successfully processed

Body

application/json

metaMetaObject (object)

Additional data

dataarray of TemplateObjectWithTime (all of)

Request

var client = new RestClient("https://api.messageflow.com/v2.1/email/template?offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&smtpAccount=SOME_STRING_VALUE&externalId=SOME_STRING_VALUE");
var request = new RestRequest(Method.GET);
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
request.AddHeader("application-key", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Response

{
  "meta": {
    "numberOfData": 1,
    "status": 200,
    "uniqId": "00d928f759"
  },
  "data": [
    {
      "html": "text",
      "text": "text",
      "name": "text",
      "externalId": "text",
      "smtpAccount": "text",
      "createdAt": "text"
    }
  ]
}

C#

var client = new RestClient("https://api.messageflow.com/v2.1/email/template?offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&smtpAccount=SOME_STRING_VALUE&externalId=SOME_STRING_VALUE");
var request = new RestRequest(Method.GET);
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Go

package main

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

func main() {

	url := "https://api.messageflow.com/v2.1/email/template?offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&smtpAccount=SOME_STRING_VALUE&externalId=SOME_STRING_VALUE"

	req, _ := http.NewRequest("GET", url, nil)

	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.get("https://api.messageflow.com/v2.1/email/template?offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&smtpAccount=SOME_STRING_VALUE&externalId=SOME_STRING_VALUE")
  .header("authorization", "REPLACE_KEY_VALUE")
  .asString();

Node

var request = require("request");

var options = {
  method: 'GET',
  url: 'https://api.messageflow.com/v2.1/email/template',
  qs: {
    offset: 'SOME_INTEGER_VALUE',
    limit: 'SOME_INTEGER_VALUE',
    smtpAccount: 'SOME_STRING_VALUE',
    externalId: 'SOME_STRING_VALUE'
  },
  headers: {authorization: 'REPLACE_KEY_VALUE'}
};

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/email/template?offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&smtpAccount=SOME_STRING_VALUE&externalId=SOME_STRING_VALUE",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "authorization: REPLACE_KEY_VALUE"
  ),
));

$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/email/template"

querystring = {"offset":"SOME_INTEGER_VALUE","limit":"SOME_INTEGER_VALUE","smtpAccount":"SOME_STRING_VALUE","externalId":"SOME_STRING_VALUE"}

headers = {'authorization': 'REPLACE_KEY_VALUE'}

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

print(response.text)

Ruby

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

url = URI("https://api.messageflow.com/v2.1/email/template?offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&smtpAccount=SOME_STRING_VALUE&externalId=SOME_STRING_VALUE")

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

request = Net::HTTP::Get.new(url)
request["authorization"] = 'REPLACE_KEY_VALUE'

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

Shell

http GET 'https://api.messageflow.com/v2.1/email/template?offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&smtpAccount=SOME_STRING_VALUE&externalId=SOME_STRING_VALUE' \
  authorization:REPLACE_KEY_VALUEuthorization: REPLACE_KEY_VALUE'

Add template

Use this method to add email template which you can use with the Send emails method.

POSThttps://api.messageflow.com/v2.1/email/template

Body

application/json

htmlstring

The HTML content of your message.

textstring

The plain text content of your message.

namestring

The name of the new template.

externalIdstring

The unique ID of the new template. If you won’t add it the externalId will be generated in the response.

smtpAccountstring

The name of your smtp account you want the new template to be saved on.

Response

200207401404500

Request was successfully processed

Body

application/json

metaMetaObject (object)

Additional data

Request

var client = new RestClient("https://api.messageflow.com/v2.1/email/template");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
request.AddHeader("application-key", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"html\":\"string\",\"text\":\"string\",\"name\":\"string\",\"externalId\":\"string\",\"smtpAccount\":\"string\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Response

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

C#

var client = new RestClient("https://api.messageflow.com/v2.1/email/template");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"html\":\"string\",\"text\":\"string\",\"name\":\"string\",\"externalId\":\"string\",\"smtpAccount\":\"string\"}", 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/email/template"

	payload := strings.NewReader("{\"html\":\"string\",\"text\":\"string\",\"name\":\"string\",\"externalId\":\"string\",\"smtpAccount\":\"string\"}")

	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/email/template")
  .header("content-type", "application/json")
  .header("authorization", "REPLACE_KEY_VALUE")
  .body("{\"html\":\"string\",\"text\":\"string\",\"name\":\"string\",\"externalId\":\"string\",\"smtpAccount\":\"string\"}")
  .asString();

Node

var request = require("request");

var options = {
  method: 'POST',
  url: 'https://api.messageflow.com/v2.1/email/template',
  headers: {'content-type': 'application/json', authorization: 'REPLACE_KEY_VALUE'},
  body: {
    html: 'string',
    text: 'string',
    name: 'string',
    externalId: 'string',
    smtpAccount: 'string'
  },
  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/email/template",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"html\":\"string\",\"text\":\"string\",\"name\":\"string\",\"externalId\":\"string\",\"smtpAccount\":\"string\"}",
  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/email/template"

payload = "{\"html\":\"string\",\"text\":\"string\",\"name\":\"string\",\"externalId\":\"string\",\"smtpAccount\":\"string\"}"
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/email/template")

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 = "{\"html\":\"string\",\"text\":\"string\",\"name\":\"string\",\"externalId\":\"string\",\"smtpAccount\":\"string\"}"

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

Shell

echo '{"html":"string","text":"string","name":"string","externalId":"string","smtpAccount":"string"}' |  \
  http POST https://api.messageflow.com/v2.1/email/template \
  authorization:REPLACE_KEY_VALUE \
  content-type:application/jsonternalId":"string","smtpAccount":"string"}'

Delete template

Use this method to delete email templates.

DELETEhttps://api.messageflow.com/v2.1/email/template

Body

application/json

externalIdarray of string

The unique ID of the template.

Response

200207401404500

Request was successfully processed

Body

application/json

metaMetaObject (object)

Additional data

Request

var client = new RestClient("https://api.messageflow.com/v2.1/email/template");
var request = new RestRequest(Method.DELETE);
request.AddHeader("content-type", "application/json");
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
request.AddHeader("application-key", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"externalId\":[\"XXX-XXX\"]}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Response

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

C#

var client = new RestClient("https://api.redlink.pl/v2.1/email/template");
var request = new RestRequest(Method.DELETE);
request.AddHeader("content-type", "application/json");
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"externalId\":[\"XXX-XXX\"]}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Go

package main

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

func main() {

	url := "https://api.redlink.pl/v2.1/email/template"

	payload := strings.NewReader("{\"externalId\":[\"XXX-XXX\"]}")

	req, _ := http.NewRequest("DELETE", 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.delete("https://api.redlink.pl/v2.1/email/template")
  .header("content-type", "application/json")
  .header("authorization", "REPLACE_KEY_VALUE")
  .body("{\"externalId\":[\"XXX-XXX\"]}")
  .asString();

Node

var request = require("request");

var options = {
  method: 'DELETE',
  url: 'https://api.redlink.pl/v2.1/email/template',
  headers: {'content-type': 'application/json', authorization: 'REPLACE_KEY_VALUE'},
  body: {externalId: ['XXX-XXX']},
  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.redlink.pl/v2.1/email/template",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => "{\"externalId\":[\"XXX-XXX\"]}",
  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.redlink.pl/v2.1/email/template"

payload = "{\"externalId\":[\"XXX-XXX\"]}"
headers = {
    'content-type': "application/json",
    'authorization': "REPLACE_KEY_VALUE"
    }

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

print(response.text)

Ruby

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

url = URI("https://api.redlink.pl/v2.1/email/template")

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

request = Net::HTTP::Delete.new(url)
request["content-type"] = 'application/json'
request["authorization"] = 'REPLACE_KEY_VALUE'
request.body = "{\"externalId\":[\"XXX-XXX\"]}"

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

Shell

curl --request DELETE \
  --url https://api.redlink.pl/v2.1/email/template \
  --header 'authorization: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"externalId":["XXX-XXX"]}'