Recipient

List email campaign recipients

get

Use this method to get all recipients from the email campaign. You can filter recipients who have got bounce states as well.

Authorizations

APIKeyHeaderAPPKeyHeader

Query parameters

campaignIdstringoptional

Search with campaign external ID. The search by campaignId does not work in conjunction with the date search. These two search options are incompatible and must be used separately.

Example: 6F8EB428-0917-4DE7-BE1D-ACCD7432A4B8

bouncesOnlybooloptional

If true then action will return only bounced recipients

dateTostringoptional

Search with date (UTC timezone). The search by date does not work in conjunction with the search by campaignId. These two search options are incompatible and must be used separately.

Example: YYYY-MM-DD hh:mm:iiPattern: /(^\d{4}-\d{2}-\d{2})\s(\d{2}:\d{2}:\d{2})$/

dateFromstringoptional

Search with date (UTC timezone). The search by date does not work in conjunction with the search by campaignId. These two search options are incompatible and must be used separately.

Example: YYYY-MM-DD hh:mm:iiPattern: /(^\d{4}-\d{2}-\d{2})\s(\d{2}:\d{2}:\d{2})$/

limitinteger · max: 1000optional

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

Default: 100

offsetintegeroptional

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

Default: 0

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/campaign/email/report/recipient?campaignId=6F8EB428-0917-4DE7-BE1D-ACCD7432A4B8&bouncesOnly=<bool>&dateTo=YYYY-MM-DD hh:mm:ii&dateFrom=YYYY-MM-DD hh:mm:ii&limit=100&offset=0");

            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": [
    {
      "code": 1,
      "email": "text"
    }
  ]
}