Email

Get email statuses

Use this method to get details of the email with statuses such as injected, ok, softbounce, hardbounce, spambounce, deffered and dropped. By default, you can only access data from the last week

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

Authorization

APIKeyHeader

Query parameters

Response

200401404500

Request was successfully processed

Body

application/json

metaobject

Additional data

dataarray of object

Request

CsharpGoJavaNodePhpPythonRubyShell

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

Response

200401404500

{
  "meta": {
    "numberOfErrors": 0,
    "numberOfData": 1,
    "status": 200,
    "uniqId": "00d928f759"
  },
  "data": [
    {
      "subject": "text",
      "smtpAccount": "1.test.smtp",
      "tags": [
        "text"
      ],
      "to": [
        {
          "email": "[e-mail]",
          "name": "Test sender",
          "messageId": "[e-mail]"
        }
      ],
      "from": {
        "email": "text",
        "name": "text"
      },
      "status": "text",
      "statusTime": 1,
      "statusDesc": "text",
      "allStatuses": [
        {
          "status": "text",
          "statusTime": 1,
          "statusDesc": "text"
        }
      ]
    }
  ]
}

Send emails

Send new email through transactional API which means that you can send email to a single email address or an array of email addresses. You can send the message to a maximum of 200 recipients. The entire query should not exceed 10 MB, and should not exceed 10 000 elements. If you want to send email to a group created through Create group method please use Send email campaign.

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

Authorization

APIKeyHeader

Body

application/json

subject*string

The subject of the message.

Example: "Test email subject"

smtpAccount*string

The smtp account name the email will be sent from.

Example: "1.test.smtp"

tagsarray of string

The values to tag the message with. Tags can be non-unique.

content*object

The body of the message. If you choose templateId html and text can be omitted.

bccarray of object

The array of recipients who will receive a blind carbon copy of your email.

ccarray of object

The array of recipients who will receive a copy of your email.

from*object

The details of sender.

replyToobject

The details of who the recipient can reply to.

headersobject

The extra key/value pair of the headers you can add to the message. Property name can contain max of 100 signs.

Example: {"X-TEST-HEADER":"val"}

globalVarsobject

The extra variables you can use in your e-mial template. You can find more information on how to use this feature in this section.

Example: {"sex":"unknown","hasNewsletter":false,"promos":{"1":{"name":"test40","value":300},"2":{"name":"test800","value":3008}},"footer":"<div><strong>crazy footer</strong></div>"}

to*array of object

The details of the recipients.

attachmentsarray of object

The details of the attachments. The entire query should not exceed 10 MB.

Response

200207401404500

Request was successfully processed

Body

application/json

metaobject

Additional data

dataarray of object

Request

CsharpGoJavaNodePhpPythonRubyShell

var client = new RestClient("https://api.redlink.pl/v2.1/email");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"subject\":\"Test email subject\",\"smtpAccount\":\"1.test.smtp\",\"tags\":[\"test-tag\"],\"content\":{\"html\":\"<h1>Hello world</h1>\",\"text\":\"Hello world\",\"templateId\":\"as2sCwq\"},\"bcc\":[{\"email\":\"string\",\"name\":\"string\"}],\"cc\":[{\"email\":\"string\",\"name\":\"string\"}],\"from\":{\"email\":\"string\",\"name\":\"string\"},\"replyTo\":{\"email\":\"string\",\"name\":\"string\"},\"headers\":{\"X-TEST-HEADER\":\"val\"},\"to\":[{\"email\":\"[e-mail]\",\"name\":\"Test sender\",\"messageId\":\"[e-mail]\",\"vars\":{\"test-var\":\"var-value\"}}],\"attachments\":[{\"fileName\":\"report.txt\",\"fileMime\":\"text/plain\",\"fileContent\":\"c29tZSBmaWxlIGNvbnRlbnQ=\"}]}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Response

200207401404500

{
  "meta": {
    "numberOfErrors": 0,
    "numberOfData": 1,
    "status": 200,
    "uniqId": "00d928f759"
  },
  "data": [
    {
      "subject": "text",
      "smtpAccount": "1.test.smtp",
      "tags": [
        "text"
      ],
      "to": [
        {
          "email": "[e-mail]",
          "name": "Test sender",
          "messageId": "[e-mail]"
        }
      ],
      "from": {
        "email": "text",
        "name": "text"
      },
      "status": "text",
      "statusTime": 1,
      "statusDesc": "text",
      "allStatuses": [
        {
          "status": "text",
          "statusTime": 1,
          "statusDesc": "text"
        }
      ]
    }
  ]
}