Unsubscribe

Get email campaign unsubscribe report

Use this method to get date of a click on unsubscribe link and the email address of the unsubscribed.

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

Authorization

APIKeyHeader

Path parameters

campaignId*string

Id of existing campaign

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/campaign/email/%7BcampaignId%7D/report/unsubscribe?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

200401404500

{
  "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"
    }
  ]
}