GET newslettercampaign/getrecipients?friendlyurl={friendlyurl}

Gets the recipients.

Request Information

Parameters

Name	Description	Additional information
friendlyUrl	The friendly URL.	Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:

[
  {
    "Forename": "sample string 1",
    "Surname": "sample string 2",
    "Email": "sample string 3",
    "IsNonMailingListUser": true,
    "Delivered": true,
    "DeliveredDatestamp": "2025-11-17T10:48:38.4004255+00:00",
    "FailureCount": 1,
    "FailureReason": "sample string 5",
    "FailureDescription": "sample string 6",
    "FailureDatestamp": "2025-11-17T10:48:38.4004255+00:00",
    "HasMarkedSpam": true,
    "SpamDatestamp": "2025-11-17T10:48:38.4004255+00:00",
    "OpensCount": 8,
    "ClicksCount": 9,
    "BouncesCount": 10
  },
  {
    "Forename": "sample string 1",
    "Surname": "sample string 2",
    "Email": "sample string 3",
    "IsNonMailingListUser": true,
    "Delivered": true,
    "DeliveredDatestamp": "2025-11-17T10:48:38.4004255+00:00",
    "FailureCount": 1,
    "FailureReason": "sample string 5",
    "FailureDescription": "sample string 6",
    "FailureDatestamp": "2025-11-17T10:48:38.4004255+00:00",
    "HasMarkedSpam": true,
    "SpamDatestamp": "2025-11-17T10:48:38.4004255+00:00",
    "OpensCount": 8,
    "ClicksCount": 9,
    "BouncesCount": 10
  },
  {
    "Forename": "sample string 1",
    "Surname": "sample string 2",
    "Email": "sample string 3",
    "IsNonMailingListUser": true,
    "Delivered": true,
    "DeliveredDatestamp": "2025-11-17T10:48:38.4004255+00:00",
    "FailureCount": 1,
    "FailureReason": "sample string 5",
    "FailureDescription": "sample string 6",
    "FailureDatestamp": "2025-11-17T10:48:38.4004255+00:00",
    "HasMarkedSpam": true,
    "SpamDatestamp": "2025-11-17T10:48:38.4004255+00:00",
    "OpensCount": 8,
    "ClicksCount": 9,
    "BouncesCount": 10
  }
]

application/xml, text/xml

Sample:

<ArrayOfNewsletterCampaignRecipientModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webi.Api2.Models">
  <NewsletterCampaignRecipientModel>
    <BouncesCount>10</BouncesCount>
    <ClicksCount>9</ClicksCount>
    <Delivered>true</Delivered>
    <DeliveredDatestamp>2025-11-17T10:48:38.4004255+00:00</DeliveredDatestamp>
    <Email>sample string 3</Email>
    <FailureCount>1</FailureCount>
    <FailureDatestamp>2025-11-17T10:48:38.4004255+00:00</FailureDatestamp>
    <FailureDescription>sample string 6</FailureDescription>
    <FailureReason>sample string 5</FailureReason>
    <Forename>sample string 1</Forename>
    <HasMarkedSpam>true</HasMarkedSpam>
    <IsNonMailingListUser>true</IsNonMailingListUser>
    <OpensCount>8</OpensCount>
    <SpamDatestamp>2025-11-17T10:48:38.4004255+00:00</SpamDatestamp>
    <Surname>sample string 2</Surname>
  </NewsletterCampaignRecipientModel>
  <NewsletterCampaignRecipientModel>
    <BouncesCount>10</BouncesCount>
    <ClicksCount>9</ClicksCount>
    <Delivered>true</Delivered>
    <DeliveredDatestamp>2025-11-17T10:48:38.4004255+00:00</DeliveredDatestamp>
    <Email>sample string 3</Email>
    <FailureCount>1</FailureCount>
    <FailureDatestamp>2025-11-17T10:48:38.4004255+00:00</FailureDatestamp>
    <FailureDescription>sample string 6</FailureDescription>
    <FailureReason>sample string 5</FailureReason>
    <Forename>sample string 1</Forename>
    <HasMarkedSpam>true</HasMarkedSpam>
    <IsNonMailingListUser>true</IsNonMailingListUser>
    <OpensCount>8</OpensCount>
    <SpamDatestamp>2025-11-17T10:48:38.4004255+00:00</SpamDatestamp>
    <Surname>sample string 2</Surname>
  </NewsletterCampaignRecipientModel>
  <NewsletterCampaignRecipientModel>
    <BouncesCount>10</BouncesCount>
    <ClicksCount>9</ClicksCount>
    <Delivered>true</Delivered>
    <DeliveredDatestamp>2025-11-17T10:48:38.4004255+00:00</DeliveredDatestamp>
    <Email>sample string 3</Email>
    <FailureCount>1</FailureCount>
    <FailureDatestamp>2025-11-17T10:48:38.4004255+00:00</FailureDatestamp>
    <FailureDescription>sample string 6</FailureDescription>
    <FailureReason>sample string 5</FailureReason>
    <Forename>sample string 1</Forename>
    <HasMarkedSpam>true</HasMarkedSpam>
    <IsNonMailingListUser>true</IsNonMailingListUser>
    <OpensCount>8</OpensCount>
    <SpamDatestamp>2025-11-17T10:48:38.4004255+00:00</SpamDatestamp>
    <Surname>sample string 2</Surname>
  </NewsletterCampaignRecipientModel>
</ArrayOfNewsletterCampaignRecipientModel>