Template

Get template list

get

Use this method to list all created email templates.

Authorizations

APIKeyHeaderAPPKeyHeader

Query parameters

offsetintegeroptional

The number of items omitted from the beginning of the list. Default ‘0’.

Default: 0

limitinteger · max: 1000optional

The maximum number of items returned by request. Default ‘100’. Maximum ‘1000’.

Default: 100

smtpAccountstringoptional

The smtp account name.

Example: 1.test.smtp

externalIdstringoptional

The unique ID of the object you are looking for.

Responses

application/json

objectoptional

application/json

application/json

application/json

get

CsharpGoJavaNodePhpPythonRubyShell

using System.Threading.Tasks;

internal class Program
{
    private static void Main(string[] args)
    {
        string requestBody = "";

        try {
            using var client = new HttpClient{};
            using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.messageflow.com/v2.1/email/template?offset=0&limit=100&smtpAccount=1.test.smtp&externalId=<string>");

            request.Headers.Add("Authorization", "YourAuthorizationKey");
            request.Headers.Add("Application-Key", "YourApplicationKey");
            request.Content = new StringContent(requestBody, null, "application/json");

            var response = await client.SendAsync(request);
            response.EnsureSuccessStatusCode();
            string content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);

        } catch (HttpRequestException e) {
            Console.WriteLine("\n Exception Caught!\n Message :{0} ", e.Message);
        }
    }
}

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

Add template

post

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

Authorizations

APIKeyHeaderAPPKeyHeader

Body

htmlstringrequired

The HTML content of your message.

textstringrequired

The plain text content of your message.

namestringrequired

The name of the new template.

externalIdstringoptional

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

smtpAccountstringrequired

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

Responses

application/json

objectoptional

application/json

application/json

application/json

application/json

post

CsharpGoJavaNodePhpPythonRubyShell

using System.Threading.Tasks;

internal class Program
{
    private static void Main(string[] args)
    {
        string requestBody = "{\"html\":\"\",\"text\":\"\",\"name\":\"\",\"externalId\":\"\",\"smtpAccount\":\"\"}";

        try {
            using var client = new HttpClient{};
            using var request = new HttpRequestMessage(HttpMethod.Post, "https://api.messageflow.com/v2.1/email/template");

            request.Headers.Add("Authorization", "YourAuthorizationKey");
            request.Headers.Add("Application-Key", "YourApplicationKey");
            request.Content = new StringContent(requestBody, null, "application/json");

            var response = await client.SendAsync(request);
            response.EnsureSuccessStatusCode();
            string content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);

        } catch (HttpRequestException e) {
            Console.WriteLine("\n Exception Caught!\n Message :{0} ", e.Message);
        }
    }
}

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

Delete template

delete

Use this method to delete email templates.

Authorizations

APIKeyHeaderAPPKeyHeader

Body

externalIdstring[]required

The unique ID of the template.

Example: XXX-XXX

Responses

application/json

objectoptional

application/json

application/json

application/json

application/json

delete

CsharpGoJavaNodePhpPythonRubyShell

using System.Threading.Tasks;

internal class Program
{
    private static void Main(string[] args)
    {
        string requestBody = "{\"externalId\":[\"XXX-XXX\"]}";

        try {
            using var client = new HttpClient{};
            using var request = new HttpRequestMessage(HttpMethod.Delete, "https://api.messageflow.com/v2.1/email/template");

            request.Headers.Add("Authorization", "YourAuthorizationKey");
            request.Headers.Add("Application-Key", "YourApplicationKey");
            request.Content = new StringContent(requestBody, null, "application/json");

            var response = await client.SendAsync(request);
            response.EnsureSuccessStatusCode();
            string content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);

        } catch (HttpRequestException e) {
            Console.WriteLine("\n Exception Caught!\n Message :{0} ", e.Message);
        }
    }
}

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