Template | Api reference MessageFlow

Api reference MessageFlow

Get template list

Use this method to list all created email templates.

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

Authorization

Query parameters

Response

Request was successfully processed

Body

metaobject

Additional data

dataarray of all of

Request

var client = new RestClient("https://api.redlink.pl/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);

Response

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

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

Authorization

Body

html*string

The HTML content of your message.

text*string

The plain text content of your message.

name*string

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.

smtpAccount*string

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

Response

Request was successfully processed

Body

metaobject

Additional data

Request

var client = new RestClient("https://api.redlink.pl/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);

Response

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

Delete template

Use this method to delete email templates.

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

Authorization

Body

externalId*array of string

The unique ID of the template.

Response

Request was successfully processed

Body

metaobject

Additional data

Request

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);

Response

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