Recipients a campaign

Parameters

Request

curl -X GET 'https://app.mailyte.com/api/v1/campaigns/01JBT8XQ2M9WYC3K4F6R7S8T9V/recipients' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'

const response = await fetch('https://app.mailyte.com/api/v1/campaigns/01JBT8XQ2M9WYC3K4F6R7S8T9V/recipients', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer mk_live_YOUR_API_KEY',
  },
});
const { data } = await response.json();

import requests
response = requests.get(
    "https://app.mailyte.com/api/v1/campaigns/01JBT8XQ2M9WYC3K4F6R7S8T9V/recipients",
    headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
)
data = response.json()["data"]

<?php

$response = Http::withToken('mk_live_YOUR_API_KEY')
    ->get('https://app.mailyte.com/api/v1/campaigns/01JBT8XQ2M9WYC3K4F6R7S8T9V/recipients');

$data = $response->json('data');

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/campaigns/01JBT8XQ2M9WYC3K4F6R7S8T9V/recipients")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

Response

Success.

• dataobject
  • dataarray<object>
    • objectstringcampaign_recipient
    • idstring

      Unique identifier for the recipient row.

    • emailstring
    • contact_idstring

      Null for an address that reached the campaign without a contact row behind it.

    • statusstringpending | sent | failed | skipped_suppressed | skipped_unsubscribed | skipped_invalid | skipped_inbox_full | unknown

      What happened to this recipient. - pending: not attempted yet. - sent: handed to the mail server. - failed: see error. - skipped_suppressed: on your suppression list. - skipped_unsubscribed: unsubscribed. - skipped_invalid: the address does not exist, found before sending. - skipped_inbox_full: the inbox was full, so marketing to this person is held for 7 days.

    • errorstring

      What went wrong, for a person to read. Do not parse it. Null when nothing went wrong.

    • sent_atstring

      When the message was handed to the mail server. This is not delivery. Set only when status is sent; read status first.

    • opened_atstring

      When this recipient first opened the email. Null when no open has been seen.

    • clicked_atstring

      When this recipient first clicked a link. Null when no click has been seen.

  • pagination_metaany

Returned inside the standard envelope.

Errors

Every status, with what causes it and what to do, is on the error reference.