Email | Api reference MessageFlow

Api reference MessageFlow

List email campaigns

Use this method to list all campaigns and its details from a certain time range.

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

Authorization

Query parameters

Response

Request was successfully processed

Body

metaobject

Additional data

dataarray of object

Request

var client = new RestClient("https://api.redlink.pl/v2.1/campaign/email?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE&dateFrom=SOME_STRING_VALUE&dateTo=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": [
    {
      "externalId": "text",
      "name": "text",
      "description": "text",
      "subject": "text",
      "fromName": "text",
      "fromAddress": "text",
      "replyTo": "text",
      "groupId": "text",
      "scheduleTime": "text"
    }
  ]
}

Get single email campaign

Use this method to get all details of certain email campaign such as subject, fromAddress, groupId, scheduleTime and more.

GEThttps://api.messageflow.com/v2.1/campaign/email/{campaignId}

Authorization

Path parameters

campaignId*string

Id of existing campaign

Response

Request was successfully processed

Body

metaobject

Additional data

dataarray of all of

Request

var client = new RestClient("https://api.redlink.pl/v2.1/campaign/email/%7BcampaignId%7D");
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": [
    {
      "externalId": "text",
      "name": "text",
      "description": "text",
      "subject": "text",
      "fromName": "text",
      "fromAddress": "text",
      "replyTo": "text",
      "groupId": "text",
      "scheduleTime": "text",
      "state": "sent"
    }
  ]
}